code
stringlengths 501
4.91M
| package
stringlengths 2
88
| path
stringlengths 11
291
| filename
stringlengths 4
197
| parsed_code
stringlengths 0
4.91M
| quality_prob
float64 0
0.99
| learning_prob
float64 0.02
1
|
|---|---|---|---|---|---|---|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TrackAction(BaseModel):
"""An agent tracks an object for updates.Related actions:* [[FollowAction]]: Unlike FollowAction, TrackAction refers to the interest on the location of innanimates objects.* [[SubscribeAction]]: Unlike SubscribeAction, TrackAction refers to the interest on the location of innanimate objects.
References:
https://schema.org/TrackAction
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
result: (Optional[Union[List[Union[str, Any]], str, Any]]): The result produced in the action. E.g. John wrote *a book*.
actionStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the current disposition of the Action.
agent: (Optional[Union[List[Union[str, Any]], str, Any]]): The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.
instrument: (Optional[Union[List[Union[str, Any]], str, Any]]): The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.
object: (Optional[Union[List[Union[str, Any]], str, Any]]): The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read *a book*.
error: (Optional[Union[List[Union[str, Any]], str, Any]]): For failed actions, more information on the cause of the failure.
target: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a target EntryPoint, or url, for an Action.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
participant: (Optional[Union[List[Union[str, Any]], str, Any]]): Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.
deliveryMethod: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of instrument. The method of delivery.
"""
type_: str = Field(default="TrackAction", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
result: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The result produced in the action. E.g. John wrote *a book*.",
)
actionStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the current disposition of the Action.",
)
agent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote"
"a book.",
)
instrument: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.",
)
object: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object upon which the action is carried out, whose state is kept intact or changed."
"Also known as the semantic roles patient, affected or undergoer (which change their"
"state) or theme (which doesn't). E.g. John read *a book*.",
)
error: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="For failed actions, more information on the cause of the failure.",
)
target: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates a target EntryPoint, or url, for an Action.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
participant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Other co-agents that participated in the action indirectly. E.g. John wrote a book with"
"*Steve*.",
)
deliveryMethod: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of instrument. The method of delivery.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/TrackAction.py
|
TrackAction.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TrackAction(BaseModel):
"""An agent tracks an object for updates.Related actions:* [[FollowAction]]: Unlike FollowAction, TrackAction refers to the interest on the location of innanimates objects.* [[SubscribeAction]]: Unlike SubscribeAction, TrackAction refers to the interest on the location of innanimate objects.
References:
https://schema.org/TrackAction
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
result: (Optional[Union[List[Union[str, Any]], str, Any]]): The result produced in the action. E.g. John wrote *a book*.
actionStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the current disposition of the Action.
agent: (Optional[Union[List[Union[str, Any]], str, Any]]): The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.
instrument: (Optional[Union[List[Union[str, Any]], str, Any]]): The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.
object: (Optional[Union[List[Union[str, Any]], str, Any]]): The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read *a book*.
error: (Optional[Union[List[Union[str, Any]], str, Any]]): For failed actions, more information on the cause of the failure.
target: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a target EntryPoint, or url, for an Action.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
participant: (Optional[Union[List[Union[str, Any]], str, Any]]): Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.
deliveryMethod: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of instrument. The method of delivery.
"""
type_: str = Field(default="TrackAction", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
result: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The result produced in the action. E.g. John wrote *a book*.",
)
actionStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the current disposition of the Action.",
)
agent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote"
"a book.",
)
instrument: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.",
)
object: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object upon which the action is carried out, whose state is kept intact or changed."
"Also known as the semantic roles patient, affected or undergoer (which change their"
"state) or theme (which doesn't). E.g. John read *a book*.",
)
error: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="For failed actions, more information on the cause of the failure.",
)
target: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates a target EntryPoint, or url, for an Action.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
participant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Other co-agents that participated in the action indirectly. E.g. John wrote a book with"
"*Steve*.",
)
deliveryMethod: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of instrument. The method of delivery.",
)
| 0.935435 | 0.366505 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CurrencyConversionService(BaseModel):
"""A service to convert funds from one currency to another currency.
References:
https://schema.org/CurrencyConversionService
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
broker: (Optional[Union[List[Union[str, Any]], str, Any]]): An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
termsOfService: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Human-readable terms of service documentation.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
availableChannel: (Optional[Union[List[Union[str, Any]], str, Any]]): A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).
isRelatedTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, somehow related product (or multiple products).
serviceAudience: (Optional[Union[List[Union[str, Any]], str, Any]]): The audience eligible for this service.
isSimilarTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, functionally similar product (or multiple products).
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
providerMobility: (Union[List[Union[str, Any]], str, Any]): Indicates the mobility of a provided service (e.g. 'static', 'dynamic').
hoursAvailable: (Optional[Union[List[Union[str, Any]], str, Any]]): The hours during which this service or contact is available.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
serviceOutput: (Optional[Union[List[Union[str, Any]], str, Any]]): The tangible thing generated by the service, e.g. a passport, permit, etc.
produces: (Optional[Union[List[Union[str, Any]], str, Any]]): The tangible thing generated by the service, e.g. a passport, permit, etc.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
category: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
serviceType: (Union[List[Union[str, Any]], str, Any]): The type of service being offered, e.g. veterans' benefits, emergency relief, etc.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
annualPercentageRate: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The annual rate that is charged for borrowing (or made by investing), expressed as a single percentage number that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction.
interestRate: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The interest rate, charged or paid, applicable to the financial product. Note: This is different from the calculated annualPercentageRate.
feesAndCommissionsSpecification: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Description of fees, commissions, and other terms applied either to a class of financial product, or by a financial service organization.
"""
type_: str = Field(default="CurrencyConversionService", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
broker: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An entity that arranges for an exchange between a buyer and a seller. In most cases a broker"
"never acquires or releases ownership of a product or service involved in an exchange."
"If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms"
"are preferred.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
termsOfService: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Human-readable terms of service documentation.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
availableChannel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).",
)
isRelatedTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, somehow related product (or multiple products).",
)
serviceAudience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The audience eligible for this service.",
)
isSimilarTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, functionally similar product (or multiple products).",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
providerMobility: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the mobility of a provided service (e.g. 'static', 'dynamic').",
)
hoursAvailable: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The hours during which this service or contact is available.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
serviceOutput: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The tangible thing generated by the service, e.g. a passport, permit, etc.",
)
produces: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The tangible thing generated by the service, e.g. a passport, permit, etc.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
category: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A category for the item. Greater signs or slashes can be used to informally indicate a"
"category hierarchy.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
serviceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The type of service being offered, e.g. veterans' benefits, emergency relief, etc.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
annualPercentageRate: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The annual rate that is charged for borrowing (or made by investing), expressed as a single"
"percentage number that represents the actual yearly cost of funds over the term of a loan."
"This includes any fees or additional costs associated with the transaction.",
)
interestRate: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The interest rate, charged or paid, applicable to the financial product. Note: This"
"is different from the calculated annualPercentageRate.",
)
feesAndCommissionsSpecification: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="Description of fees, commissions, and other terms applied either to a class of financial"
"product, or by a financial service organization.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/CurrencyConversionService.py
|
CurrencyConversionService.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CurrencyConversionService(BaseModel):
"""A service to convert funds from one currency to another currency.
References:
https://schema.org/CurrencyConversionService
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
broker: (Optional[Union[List[Union[str, Any]], str, Any]]): An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
termsOfService: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Human-readable terms of service documentation.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
availableChannel: (Optional[Union[List[Union[str, Any]], str, Any]]): A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).
isRelatedTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, somehow related product (or multiple products).
serviceAudience: (Optional[Union[List[Union[str, Any]], str, Any]]): The audience eligible for this service.
isSimilarTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, functionally similar product (or multiple products).
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
providerMobility: (Union[List[Union[str, Any]], str, Any]): Indicates the mobility of a provided service (e.g. 'static', 'dynamic').
hoursAvailable: (Optional[Union[List[Union[str, Any]], str, Any]]): The hours during which this service or contact is available.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
serviceOutput: (Optional[Union[List[Union[str, Any]], str, Any]]): The tangible thing generated by the service, e.g. a passport, permit, etc.
produces: (Optional[Union[List[Union[str, Any]], str, Any]]): The tangible thing generated by the service, e.g. a passport, permit, etc.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
category: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
serviceType: (Union[List[Union[str, Any]], str, Any]): The type of service being offered, e.g. veterans' benefits, emergency relief, etc.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
annualPercentageRate: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The annual rate that is charged for borrowing (or made by investing), expressed as a single percentage number that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction.
interestRate: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The interest rate, charged or paid, applicable to the financial product. Note: This is different from the calculated annualPercentageRate.
feesAndCommissionsSpecification: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Description of fees, commissions, and other terms applied either to a class of financial product, or by a financial service organization.
"""
type_: str = Field(default="CurrencyConversionService", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
broker: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An entity that arranges for an exchange between a buyer and a seller. In most cases a broker"
"never acquires or releases ownership of a product or service involved in an exchange."
"If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms"
"are preferred.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
termsOfService: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Human-readable terms of service documentation.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
availableChannel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).",
)
isRelatedTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, somehow related product (or multiple products).",
)
serviceAudience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The audience eligible for this service.",
)
isSimilarTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, functionally similar product (or multiple products).",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
providerMobility: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the mobility of a provided service (e.g. 'static', 'dynamic').",
)
hoursAvailable: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The hours during which this service or contact is available.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
serviceOutput: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The tangible thing generated by the service, e.g. a passport, permit, etc.",
)
produces: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The tangible thing generated by the service, e.g. a passport, permit, etc.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
category: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A category for the item. Greater signs or slashes can be used to informally indicate a"
"category hierarchy.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
serviceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The type of service being offered, e.g. veterans' benefits, emergency relief, etc.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
annualPercentageRate: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The annual rate that is charged for borrowing (or made by investing), expressed as a single"
"percentage number that represents the actual yearly cost of funds over the term of a loan."
"This includes any fees or additional costs associated with the transaction.",
)
interestRate: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The interest rate, charged or paid, applicable to the financial product. Note: This"
"is different from the calculated annualPercentageRate.",
)
feesAndCommissionsSpecification: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="Description of fees, commissions, and other terms applied either to a class of financial"
"product, or by a financial service organization.",
)
| 0.888457 | 0.38004 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Hostel(BaseModel):
"""A hostel - cheap accommodation, often in shared dormitories.<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>.
References:
https://schema.org/Hostel
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
priceRange: (Union[List[Union[str, Any]], str, Any]): The price range of the business, for example ```$$$```.
currenciesAccepted: (Union[List[Union[str, Any]], str, Any]): The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
branchOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].
paymentAccepted: (Union[List[Union[str, Any]], str, Any]): Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
numberOfRooms: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business.Typical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue.
availableLanguage: (Union[List[Union[str, Any]], str, Any]): A language someone may use with or at the item, service or place. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]].
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
checkoutTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The latest someone may check out of a lodging establishment.
starRating: (Optional[Union[List[Union[str, Any]], str, Any]]): An official rating for a lodging business or food establishment, e.g. from national associations or standards bodies. Use the author property to indicate the rating organization, e.g. as an Organization with name such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars).
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
petsAllowed: (Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]): Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value.
checkinTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The earliest someone may check into a lodging establishment.
"""
type_: str = Field(default="Hostel", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
priceRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The price range of the business, for example ```$$$```.",
)
currenciesAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217),"
'e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)'
'for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
branchOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this local business is a branch of, if any. Not to be confused"
"with (anatomical) [[branch]].",
)
paymentAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
numberOfRooms: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The number of rooms (excluding bathrooms and closets) of the accommodation or lodging"
"business.Typical unit code(s): ROM for room or C62 for no unit. The type of room can be"
"put in the unitText property of the QuantitativeValue.",
)
availableLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A language someone may use with or at the item, service or place. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[inLanguage]].",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
checkoutTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The latest someone may check out of a lodging establishment.",
)
starRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An official rating for a lodging business or food establishment, e.g. from national"
"associations or standards bodies. Use the author property to indicate the rating organization,"
"e.g. as an Organization with name such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars).",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
petsAllowed: Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any] = Field(
default=None,
description="Indicates whether pets are allowed to enter the accommodation or lodging business."
"More detailed information can be put in a text value.",
)
checkinTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The earliest someone may check into a lodging establishment.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Hostel.py
|
Hostel.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Hostel(BaseModel):
"""A hostel - cheap accommodation, often in shared dormitories.<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>.
References:
https://schema.org/Hostel
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
priceRange: (Union[List[Union[str, Any]], str, Any]): The price range of the business, for example ```$$$```.
currenciesAccepted: (Union[List[Union[str, Any]], str, Any]): The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
branchOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].
paymentAccepted: (Union[List[Union[str, Any]], str, Any]): Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
numberOfRooms: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business.Typical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue.
availableLanguage: (Union[List[Union[str, Any]], str, Any]): A language someone may use with or at the item, service or place. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[inLanguage]].
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
checkoutTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The latest someone may check out of a lodging establishment.
starRating: (Optional[Union[List[Union[str, Any]], str, Any]]): An official rating for a lodging business or food establishment, e.g. from national associations or standards bodies. Use the author property to indicate the rating organization, e.g. as an Organization with name such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars).
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
petsAllowed: (Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]): Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value.
checkinTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The earliest someone may check into a lodging establishment.
"""
type_: str = Field(default="Hostel", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
priceRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The price range of the business, for example ```$$$```.",
)
currenciesAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217),"
'e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)'
'for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
branchOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this local business is a branch of, if any. Not to be confused"
"with (anatomical) [[branch]].",
)
paymentAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
numberOfRooms: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The number of rooms (excluding bathrooms and closets) of the accommodation or lodging"
"business.Typical unit code(s): ROM for room or C62 for no unit. The type of room can be"
"put in the unitText property of the QuantitativeValue.",
)
availableLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A language someone may use with or at the item, service or place. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[inLanguage]].",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
checkoutTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The latest someone may check out of a lodging establishment.",
)
starRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An official rating for a lodging business or food establishment, e.g. from national"
"associations or standards bodies. Use the author property to indicate the rating organization,"
"e.g. as an Organization with name such as (e.g. HOTREC, DEHOGA, WHR, or Hotelstars).",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
petsAllowed: Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any] = Field(
default=None,
description="Indicates whether pets are allowed to enter the accommodation or lodging business."
"More detailed information can be put in a text value.",
)
checkinTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The earliest someone may check into a lodging establishment.",
)
| 0.865991 | 0.369713 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalImagingTechnique(BaseModel):
"""Any medical imaging modality typically used for diagnostic purposes. Enumerated type.
References:
https://schema.org/MedicalImagingTechnique
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="MedicalImagingTechnique", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MedicalImagingTechnique.py
|
MedicalImagingTechnique.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalImagingTechnique(BaseModel):
"""Any medical imaging modality typically used for diagnostic purposes. Enumerated type.
References:
https://schema.org/MedicalImagingTechnique
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="MedicalImagingTechnique", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.943712 | 0.322499 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Attorney(BaseModel):
"""Professional service: Attorney. This type is deprecated - [[LegalService]] is more inclusive and less ambiguous.
References:
https://schema.org/Attorney
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
priceRange: (Union[List[Union[str, Any]], str, Any]): The price range of the business, for example ```$$$```.
currenciesAccepted: (Union[List[Union[str, Any]], str, Any]): The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
branchOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].
paymentAccepted: (Union[List[Union[str, Any]], str, Any]): Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
"""
type_: str = Field(default="Attorney", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
priceRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The price range of the business, for example ```$$$```.",
)
currenciesAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217),"
'e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)'
'for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
branchOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this local business is a branch of, if any. Not to be confused"
"with (anatomical) [[branch]].",
)
paymentAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Attorney.py
|
Attorney.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Attorney(BaseModel):
"""Professional service: Attorney. This type is deprecated - [[LegalService]] is more inclusive and less ambiguous.
References:
https://schema.org/Attorney
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
priceRange: (Union[List[Union[str, Any]], str, Any]): The price range of the business, for example ```$$$```.
currenciesAccepted: (Union[List[Union[str, Any]], str, Any]): The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
branchOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].
paymentAccepted: (Union[List[Union[str, Any]], str, Any]): Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
"""
type_: str = Field(default="Attorney", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
priceRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The price range of the business, for example ```$$$```.",
)
currenciesAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217),"
'e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)'
'for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
branchOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this local business is a branch of, if any. Not to be confused"
"with (anatomical) [[branch]].",
)
paymentAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
| 0.883003 | 0.346873 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Collection(BaseModel):
"""A collection of items, e.g. creative works or products.
References:
https://schema.org/Collection
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
collectionSize: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of items in the [[Collection]].
"""
type_: str = Field(default="Collection", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
collectionSize: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of items in the [[Collection]].",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Collection.py
|
Collection.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Collection(BaseModel):
"""A collection of items, e.g. creative works or products.
References:
https://schema.org/Collection
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
collectionSize: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of items in the [[Collection]].
"""
type_: str = Field(default="Collection", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
collectionSize: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of items in the [[Collection]].",
)
| 0.920025 | 0.317664 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class GameServer(BaseModel):
"""Server that provides game interaction in a multiplayer game.
References:
https://schema.org/GameServer
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
playersOnline: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): Number of players on the server.
game: (Optional[Union[List[Union[str, Any]], str, Any]]): Video game which is played on this server.
serverStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Status of a game server.
"""
type_: str = Field(default="GameServer", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
playersOnline: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="Number of players on the server.",
)
game: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Video game which is played on this server.",
)
serverStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Status of a game server.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/GameServer.py
|
GameServer.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class GameServer(BaseModel):
"""Server that provides game interaction in a multiplayer game.
References:
https://schema.org/GameServer
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
playersOnline: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): Number of players on the server.
game: (Optional[Union[List[Union[str, Any]], str, Any]]): Video game which is played on this server.
serverStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Status of a game server.
"""
type_: str = Field(default="GameServer", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
playersOnline: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="Number of players on the server.",
)
game: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Video game which is played on this server.",
)
serverStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Status of a game server.",
)
| 0.932676 | 0.313315 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BusinessSupport(BaseModel):
"""BusinessSupport: this is a benefit for supporting businesses.
References:
https://schema.org/BusinessSupport
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="BusinessSupport", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/BusinessSupport.py
|
BusinessSupport.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BusinessSupport(BaseModel):
"""BusinessSupport: this is a benefit for supporting businesses.
References:
https://schema.org/BusinessSupport
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="BusinessSupport", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.943932 | 0.295789 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class InteractionCounter(BaseModel):
"""A summary of how users have interacted with this CreativeWork. In most cases, authors will use a subtype to specify the specific type of interaction.
References:
https://schema.org/InteractionCounter
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
interactionType: (Optional[Union[List[Union[str, Any]], str, Any]]): The Action representing the type of interaction. For up votes, +1s, etc. use [[LikeAction]]. For down votes use [[DislikeAction]]. Otherwise, use the most specific Action.
interactionService: (Optional[Union[List[Union[str, Any]], str, Any]]): The WebSite or SoftwareApplication where the interactions took place.
userInteractionCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
"""
type_: str = Field(default="InteractionCounter", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
interactionType: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Action representing the type of interaction. For up votes, +1s, etc. use [[LikeAction]]."
"For down votes use [[DislikeAction]]. Otherwise, use the most specific Action.",
)
interactionService: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The WebSite or SoftwareApplication where the interactions took place.",
)
userInteractionCount: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/InteractionCounter.py
|
InteractionCounter.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class InteractionCounter(BaseModel):
"""A summary of how users have interacted with this CreativeWork. In most cases, authors will use a subtype to specify the specific type of interaction.
References:
https://schema.org/InteractionCounter
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
interactionType: (Optional[Union[List[Union[str, Any]], str, Any]]): The Action representing the type of interaction. For up votes, +1s, etc. use [[LikeAction]]. For down votes use [[DislikeAction]]. Otherwise, use the most specific Action.
interactionService: (Optional[Union[List[Union[str, Any]], str, Any]]): The WebSite or SoftwareApplication where the interactions took place.
userInteractionCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
"""
type_: str = Field(default="InteractionCounter", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
interactionType: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Action representing the type of interaction. For up votes, +1s, etc. use [[LikeAction]]."
"For down votes use [[DislikeAction]]. Otherwise, use the most specific Action.",
)
interactionService: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The WebSite or SoftwareApplication where the interactions took place.",
)
userInteractionCount: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
| 0.952794 | 0.379206 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Thursday(BaseModel):
"""The day of the week between Wednesday and Friday.
References:
https://schema.org/Thursday
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Thursday", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Thursday.py
|
Thursday.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Thursday(BaseModel):
"""The day of the week between Wednesday and Friday.
References:
https://schema.org/Thursday
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Thursday", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.925676 | 0.345022 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BloodTest(BaseModel):
"""A medical test performed on a sample of a patient's blood.
References:
https://schema.org/BloodTest
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
recognizingAuthority: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.
relevantSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, a medical specialty in which this entity is relevant.
medicineSystem: (Optional[Union[List[Union[str, Any]], str, Any]]): The system of medicine that includes this MedicalEntity, for example 'evidence-based', 'homeopathic', 'chiropractic', etc.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
legalStatus: (Union[List[Union[str, Any]], str, Any]): The drug or supplement's legal status, including any controlled substance schedules that apply.
study: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical study or trial related to this entity.
guideline: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical guideline related to this entity.
code: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
affectedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Drugs that affect the test's results.
normalRange: (Union[List[Union[str, Any]], str, Any]): Range of acceptable values for a typical patient, when applicable.
signDetected: (Optional[Union[List[Union[str, Any]], str, Any]]): A sign detected by the test.
usedToDiagnose: (Optional[Union[List[Union[str, Any]], str, Any]]): A condition the test is used to diagnose.
usesDevice: (Optional[Union[List[Union[str, Any]], str, Any]]): Device used to perform the test.
"""
type_: str = Field(default="BloodTest", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
recognizingAuthority: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, the organization that officially recognizes this entity as part of its"
"endorsed system of medicine.",
)
relevantSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, a medical specialty in which this entity is relevant.",
)
medicineSystem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The system of medicine that includes this MedicalEntity, for example 'evidence-based',"
"'homeopathic', 'chiropractic', etc.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
legalStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The drug or supplement's legal status, including any controlled substance schedules"
"that apply.",
)
study: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical study or trial related to this entity.",
)
guideline: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical guideline related to this entity.",
)
code: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical code for the entity, taken from a controlled vocabulary or ontology such as"
"ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.",
)
affectedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Drugs that affect the test's results.",
)
normalRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Range of acceptable values for a typical patient, when applicable.",
)
signDetected: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sign detected by the test.",
)
usedToDiagnose: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A condition the test is used to diagnose.",
)
usesDevice: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Device used to perform the test.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/BloodTest.py
|
BloodTest.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BloodTest(BaseModel):
"""A medical test performed on a sample of a patient's blood.
References:
https://schema.org/BloodTest
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
recognizingAuthority: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.
relevantSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, a medical specialty in which this entity is relevant.
medicineSystem: (Optional[Union[List[Union[str, Any]], str, Any]]): The system of medicine that includes this MedicalEntity, for example 'evidence-based', 'homeopathic', 'chiropractic', etc.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
legalStatus: (Union[List[Union[str, Any]], str, Any]): The drug or supplement's legal status, including any controlled substance schedules that apply.
study: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical study or trial related to this entity.
guideline: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical guideline related to this entity.
code: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
affectedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Drugs that affect the test's results.
normalRange: (Union[List[Union[str, Any]], str, Any]): Range of acceptable values for a typical patient, when applicable.
signDetected: (Optional[Union[List[Union[str, Any]], str, Any]]): A sign detected by the test.
usedToDiagnose: (Optional[Union[List[Union[str, Any]], str, Any]]): A condition the test is used to diagnose.
usesDevice: (Optional[Union[List[Union[str, Any]], str, Any]]): Device used to perform the test.
"""
type_: str = Field(default="BloodTest", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
recognizingAuthority: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, the organization that officially recognizes this entity as part of its"
"endorsed system of medicine.",
)
relevantSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, a medical specialty in which this entity is relevant.",
)
medicineSystem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The system of medicine that includes this MedicalEntity, for example 'evidence-based',"
"'homeopathic', 'chiropractic', etc.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
legalStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The drug or supplement's legal status, including any controlled substance schedules"
"that apply.",
)
study: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical study or trial related to this entity.",
)
guideline: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical guideline related to this entity.",
)
code: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical code for the entity, taken from a controlled vocabulary or ontology such as"
"ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.",
)
affectedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Drugs that affect the test's results.",
)
normalRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Range of acceptable values for a typical patient, when applicable.",
)
signDetected: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sign detected by the test.",
)
usedToDiagnose: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A condition the test is used to diagnose.",
)
usesDevice: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Device used to perform the test.",
)
| 0.934283 | 0.363788 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ImagingTest(BaseModel):
"""Any medical imaging modality typically used for diagnostic purposes.
References:
https://schema.org/ImagingTest
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
recognizingAuthority: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.
relevantSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, a medical specialty in which this entity is relevant.
medicineSystem: (Optional[Union[List[Union[str, Any]], str, Any]]): The system of medicine that includes this MedicalEntity, for example 'evidence-based', 'homeopathic', 'chiropractic', etc.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
legalStatus: (Union[List[Union[str, Any]], str, Any]): The drug or supplement's legal status, including any controlled substance schedules that apply.
study: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical study or trial related to this entity.
guideline: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical guideline related to this entity.
code: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
affectedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Drugs that affect the test's results.
normalRange: (Union[List[Union[str, Any]], str, Any]): Range of acceptable values for a typical patient, when applicable.
signDetected: (Optional[Union[List[Union[str, Any]], str, Any]]): A sign detected by the test.
usedToDiagnose: (Optional[Union[List[Union[str, Any]], str, Any]]): A condition the test is used to diagnose.
usesDevice: (Optional[Union[List[Union[str, Any]], str, Any]]): Device used to perform the test.
imagingTechnique: (Optional[Union[List[Union[str, Any]], str, Any]]): Imaging technique used.
"""
type_: str = Field(default="ImagingTest", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
recognizingAuthority: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, the organization that officially recognizes this entity as part of its"
"endorsed system of medicine.",
)
relevantSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, a medical specialty in which this entity is relevant.",
)
medicineSystem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The system of medicine that includes this MedicalEntity, for example 'evidence-based',"
"'homeopathic', 'chiropractic', etc.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
legalStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The drug or supplement's legal status, including any controlled substance schedules"
"that apply.",
)
study: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical study or trial related to this entity.",
)
guideline: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical guideline related to this entity.",
)
code: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical code for the entity, taken from a controlled vocabulary or ontology such as"
"ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.",
)
affectedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Drugs that affect the test's results.",
)
normalRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Range of acceptable values for a typical patient, when applicable.",
)
signDetected: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sign detected by the test.",
)
usedToDiagnose: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A condition the test is used to diagnose.",
)
usesDevice: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Device used to perform the test.",
)
imagingTechnique: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Imaging technique used.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/ImagingTest.py
|
ImagingTest.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ImagingTest(BaseModel):
"""Any medical imaging modality typically used for diagnostic purposes.
References:
https://schema.org/ImagingTest
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
recognizingAuthority: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.
relevantSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, a medical specialty in which this entity is relevant.
medicineSystem: (Optional[Union[List[Union[str, Any]], str, Any]]): The system of medicine that includes this MedicalEntity, for example 'evidence-based', 'homeopathic', 'chiropractic', etc.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
legalStatus: (Union[List[Union[str, Any]], str, Any]): The drug or supplement's legal status, including any controlled substance schedules that apply.
study: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical study or trial related to this entity.
guideline: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical guideline related to this entity.
code: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
affectedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Drugs that affect the test's results.
normalRange: (Union[List[Union[str, Any]], str, Any]): Range of acceptable values for a typical patient, when applicable.
signDetected: (Optional[Union[List[Union[str, Any]], str, Any]]): A sign detected by the test.
usedToDiagnose: (Optional[Union[List[Union[str, Any]], str, Any]]): A condition the test is used to diagnose.
usesDevice: (Optional[Union[List[Union[str, Any]], str, Any]]): Device used to perform the test.
imagingTechnique: (Optional[Union[List[Union[str, Any]], str, Any]]): Imaging technique used.
"""
type_: str = Field(default="ImagingTest", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
recognizingAuthority: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, the organization that officially recognizes this entity as part of its"
"endorsed system of medicine.",
)
relevantSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, a medical specialty in which this entity is relevant.",
)
medicineSystem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The system of medicine that includes this MedicalEntity, for example 'evidence-based',"
"'homeopathic', 'chiropractic', etc.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
legalStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The drug or supplement's legal status, including any controlled substance schedules"
"that apply.",
)
study: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical study or trial related to this entity.",
)
guideline: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical guideline related to this entity.",
)
code: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical code for the entity, taken from a controlled vocabulary or ontology such as"
"ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.",
)
affectedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Drugs that affect the test's results.",
)
normalRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Range of acceptable values for a typical patient, when applicable.",
)
signDetected: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sign detected by the test.",
)
usedToDiagnose: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A condition the test is used to diagnose.",
)
usesDevice: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Device used to perform the test.",
)
imagingTechnique: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Imaging technique used.",
)
| 0.931991 | 0.321673 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Balance(BaseModel):
"""Physical activity that is engaged to help maintain posture and balance.
References:
https://schema.org/Balance
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Balance", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Balance.py
|
Balance.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Balance(BaseModel):
"""Physical activity that is engaged to help maintain posture and balance.
References:
https://schema.org/Balance
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Balance", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.941822 | 0.312291 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableSizeGroupWomens(BaseModel):
"""Size group "Womens" for wearables.
References:
https://schema.org/WearableSizeGroupWomens
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="WearableSizeGroupWomens", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/WearableSizeGroupWomens.py
|
WearableSizeGroupWomens.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableSizeGroupWomens(BaseModel):
"""Size group "Womens" for wearables.
References:
https://schema.org/WearableSizeGroupWomens
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="WearableSizeGroupWomens", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.944061 | 0.30047 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class FailedActionStatus(BaseModel):
"""An action that failed to complete. The action's error property and the HTTP return code contain more information about the failure.
References:
https://schema.org/FailedActionStatus
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="FailedActionStatus", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/FailedActionStatus.py
|
FailedActionStatus.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class FailedActionStatus(BaseModel):
"""An action that failed to complete. The action's error property and the HTTP return code contain more information about the failure.
References:
https://schema.org/FailedActionStatus
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="FailedActionStatus", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.945235 | 0.321873 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PaymentComplete(BaseModel):
"""The payment has been received and processed.
References:
https://schema.org/PaymentComplete
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="PaymentComplete", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/PaymentComplete.py
|
PaymentComplete.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PaymentComplete(BaseModel):
"""The payment has been received and processed.
References:
https://schema.org/PaymentComplete
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="PaymentComplete", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.919746 | 0.320914 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PaymentDue(BaseModel):
"""The payment is due, but still within an acceptable time to be received.
References:
https://schema.org/PaymentDue
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="PaymentDue", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/PaymentDue.py
|
PaymentDue.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PaymentDue(BaseModel):
"""The payment is due, but still within an acceptable time to be received.
References:
https://schema.org/PaymentDue
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="PaymentDue", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.944868 | 0.315354 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SeeDoctorHealthAspect(BaseModel):
"""Information about questions that may be asked, when to see a professional, measures before seeing a doctor or content about the first consultation.
References:
https://schema.org/SeeDoctorHealthAspect
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="SeeDoctorHealthAspect", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/SeeDoctorHealthAspect.py
|
SeeDoctorHealthAspect.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SeeDoctorHealthAspect(BaseModel):
"""Information about questions that may be asked, when to see a professional, measures before seeing a doctor or content about the first consultation.
References:
https://schema.org/SeeDoctorHealthAspect
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="SeeDoctorHealthAspect", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.944906 | 0.323768 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Subscription(BaseModel):
"""Represents the subscription pricing component of the total price for an offered product.
References:
https://schema.org/Subscription
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Subscription", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Subscription.py
|
Subscription.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Subscription(BaseModel):
"""Represents the subscription pricing component of the total price for an offered product.
References:
https://schema.org/Subscription
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Subscription", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.946535 | 0.334576 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OnlineOnly(BaseModel):
"""Indicates that the item is available only online.
References:
https://schema.org/OnlineOnly
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="OnlineOnly", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/OnlineOnly.py
|
OnlineOnly.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OnlineOnly(BaseModel):
"""Indicates that the item is available only online.
References:
https://schema.org/OnlineOnly
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="OnlineOnly", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.943171 | 0.312173 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class AndroidPlatform(BaseModel):
"""Represents the broad notion of Android-based operating systems.
References:
https://schema.org/AndroidPlatform
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="AndroidPlatform", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/AndroidPlatform.py
|
AndroidPlatform.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class AndroidPlatform(BaseModel):
"""Represents the broad notion of Android-based operating systems.
References:
https://schema.org/AndroidPlatform
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="AndroidPlatform", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.946324 | 0.320835 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MonetaryAmountDistribution(BaseModel):
"""A statistical distribution of monetary amounts.
References:
https://schema.org/MonetaryAmountDistribution
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
percentile75: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The 75th percentile value.
percentile25: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The 25th percentile value.
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
median: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The median value.
percentile90: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The 90th percentile value.
percentile10: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The 10th percentile value.
currency: (Union[List[Union[str, Any]], str, Any]): The currency in which the monetary amount is expressed.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
"""
type_: str = Field(default="MonetaryAmountDistribution", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
percentile75: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The 75th percentile value.",
)
percentile25: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The 25th percentile value.",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
median: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The median value.",
)
percentile90: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The 90th percentile value.",
)
percentile10: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The 10th percentile value.",
)
currency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency in which the monetary amount is expressed.Use standard formats: [ISO 4217"
'currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker'
"symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies,"
'e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MonetaryAmountDistribution.py
|
MonetaryAmountDistribution.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MonetaryAmountDistribution(BaseModel):
"""A statistical distribution of monetary amounts.
References:
https://schema.org/MonetaryAmountDistribution
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
percentile75: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The 75th percentile value.
percentile25: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The 25th percentile value.
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
median: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The median value.
percentile90: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The 90th percentile value.
percentile10: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The 10th percentile value.
currency: (Union[List[Union[str, Any]], str, Any]): The currency in which the monetary amount is expressed.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
"""
type_: str = Field(default="MonetaryAmountDistribution", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
percentile75: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The 75th percentile value.",
)
percentile25: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The 25th percentile value.",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
median: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The median value.",
)
percentile90: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The 90th percentile value.",
)
percentile10: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The 10th percentile value.",
)
currency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency in which the monetary amount is expressed.Use standard formats: [ISO 4217"
'currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker'
"symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies,"
'e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
| 0.944664 | 0.391755 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CategoryCodeSet(BaseModel):
"""A set of Category Code values.
References:
https://schema.org/CategoryCodeSet
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
hasDefinedTerm: (Optional[Union[List[Union[str, Any]], str, Any]]): A Defined Term contained in this term set.
hasCategoryCode: (Optional[Union[List[Union[str, Any]], str, Any]]): A Category code contained in this code set.
"""
type_: str = Field(default="CategoryCodeSet", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
hasDefinedTerm: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A Defined Term contained in this term set.",
)
hasCategoryCode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A Category code contained in this code set.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/CategoryCodeSet.py
|
CategoryCodeSet.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CategoryCodeSet(BaseModel):
"""A set of Category Code values.
References:
https://schema.org/CategoryCodeSet
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
hasDefinedTerm: (Optional[Union[List[Union[str, Any]], str, Any]]): A Defined Term contained in this term set.
hasCategoryCode: (Optional[Union[List[Union[str, Any]], str, Any]]): A Category code contained in this code set.
"""
type_: str = Field(default="CategoryCodeSet", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
hasDefinedTerm: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A Defined Term contained in this term set.",
)
hasCategoryCode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A Category code contained in this code set.",
)
| 0.928263 | 0.32826 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MisconceptionsHealthAspect(BaseModel):
"""Content about common misconceptions and myths that are related to a topic.
References:
https://schema.org/MisconceptionsHealthAspect
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="MisconceptionsHealthAspect", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MisconceptionsHealthAspect.py
|
MisconceptionsHealthAspect.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MisconceptionsHealthAspect(BaseModel):
"""Content about common misconceptions and myths that are related to a topic.
References:
https://schema.org/MisconceptionsHealthAspect
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="MisconceptionsHealthAspect", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.945159 | 0.327359 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Flight(BaseModel):
"""An airline flight.
References:
https://schema.org/Flight
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
departureTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The expected departure time.
itinerary: (Optional[Union[List[Union[str, Any]], str, Any]]): Destination(s) ( [[Place]] ) that make up a trip. For a trip where destination order is important use [[ItemList]] to specify that order (see examples).
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
partOfTrip: (Optional[Union[List[Union[str, Any]], str, Any]]): Identifies that this [[Trip]] is a subTrip of another Trip. For example Day 1, Day 2, etc. of a multi-day trip.
arrivalTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The expected arrival time.
subTrip: (Optional[Union[List[Union[str, Any]], str, Any]]): Identifies a [[Trip]] that is a subTrip of this Trip. For example Day 1, Day 2, etc. of a multi-day trip.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
seller: (Optional[Union[List[Union[str, Any]], str, Any]]): An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.
boardingPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): The type of boarding policy used by the airline (e.g. zone-based or group-based).
webCheckinTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The time when a passenger can check into the flight online.
arrivalAirport: (Optional[Union[List[Union[str, Any]], str, Any]]): The airport where the flight terminates.
estimatedFlightDuration: (Union[List[Union[str, Any]], str, Any]): The estimated time the flight will take.
carrier: (Optional[Union[List[Union[str, Any]], str, Any]]): 'carrier' is an out-dated term indicating the 'provider' for parcel delivery and flights.
departureAirport: (Optional[Union[List[Union[str, Any]], str, Any]]): The airport where the flight originates.
mealService: (Union[List[Union[str, Any]], str, Any]): Description of the meals that will be provided or available for purchase.
flightDistance: (Union[List[Union[str, Any]], str, Any]): The distance of the flight.
departureGate: (Union[List[Union[str, Any]], str, Any]): Identifier of the flight's departure gate.
departureTerminal: (Union[List[Union[str, Any]], str, Any]): Identifier of the flight's departure terminal.
arrivalTerminal: (Union[List[Union[str, Any]], str, Any]): Identifier of the flight's arrival terminal.
flightNumber: (Union[List[Union[str, Any]], str, Any]): The unique identifier for a flight including the airline IATA code. For example, if describing United flight 110, where the IATA code for United is 'UA', the flightNumber is 'UA110'.
arrivalGate: (Union[List[Union[str, Any]], str, Any]): Identifier of the flight's arrival gate.
aircraft: (Union[List[Union[str, Any]], str, Any]): The kind of aircraft (e.g., "Boeing 747").
"""
type_: str = Field(default="Flight", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
departureTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The expected departure time.",
)
itinerary: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Destination(s) ( [[Place]] ) that make up a trip. For a trip where destination order is"
"important use [[ItemList]] to specify that order (see examples).",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
partOfTrip: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Identifies that this [[Trip]] is a subTrip of another Trip. For example Day 1, Day 2, etc."
"of a multi-day trip.",
)
arrivalTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The expected arrival time.",
)
subTrip: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Identifies a [[Trip]] that is a subTrip of this Trip. For example Day 1, Day 2, etc. of a"
"multi-day trip.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
seller: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An entity which offers (sells / leases / lends / loans) the services / goods. A seller may"
"also be a provider.",
)
boardingPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The type of boarding policy used by the airline (e.g. zone-based or group-based).",
)
webCheckinTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The time when a passenger can check into the flight online.",
)
arrivalAirport: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The airport where the flight terminates.",
)
estimatedFlightDuration: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The estimated time the flight will take.",
)
carrier: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="'carrier' is an out-dated term indicating the 'provider' for parcel delivery and flights.",
)
departureAirport: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The airport where the flight originates.",
)
mealService: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Description of the meals that will be provided or available for purchase.",
)
flightDistance: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The distance of the flight.",
)
departureGate: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the flight's departure gate.",
)
departureTerminal: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the flight's departure terminal.",
)
arrivalTerminal: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the flight's arrival terminal.",
)
flightNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The unique identifier for a flight including the airline IATA code. For example, if describing"
"United flight 110, where the IATA code for United is 'UA', the flightNumber is 'UA110'.",
)
arrivalGate: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the flight's arrival gate.",
)
aircraft: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='The kind of aircraft (e.g., "Boeing 747").',
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Flight.py
|
Flight.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Flight(BaseModel):
"""An airline flight.
References:
https://schema.org/Flight
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
departureTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The expected departure time.
itinerary: (Optional[Union[List[Union[str, Any]], str, Any]]): Destination(s) ( [[Place]] ) that make up a trip. For a trip where destination order is important use [[ItemList]] to specify that order (see examples).
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
partOfTrip: (Optional[Union[List[Union[str, Any]], str, Any]]): Identifies that this [[Trip]] is a subTrip of another Trip. For example Day 1, Day 2, etc. of a multi-day trip.
arrivalTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The expected arrival time.
subTrip: (Optional[Union[List[Union[str, Any]], str, Any]]): Identifies a [[Trip]] that is a subTrip of this Trip. For example Day 1, Day 2, etc. of a multi-day trip.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
seller: (Optional[Union[List[Union[str, Any]], str, Any]]): An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider.
boardingPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): The type of boarding policy used by the airline (e.g. zone-based or group-based).
webCheckinTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The time when a passenger can check into the flight online.
arrivalAirport: (Optional[Union[List[Union[str, Any]], str, Any]]): The airport where the flight terminates.
estimatedFlightDuration: (Union[List[Union[str, Any]], str, Any]): The estimated time the flight will take.
carrier: (Optional[Union[List[Union[str, Any]], str, Any]]): 'carrier' is an out-dated term indicating the 'provider' for parcel delivery and flights.
departureAirport: (Optional[Union[List[Union[str, Any]], str, Any]]): The airport where the flight originates.
mealService: (Union[List[Union[str, Any]], str, Any]): Description of the meals that will be provided or available for purchase.
flightDistance: (Union[List[Union[str, Any]], str, Any]): The distance of the flight.
departureGate: (Union[List[Union[str, Any]], str, Any]): Identifier of the flight's departure gate.
departureTerminal: (Union[List[Union[str, Any]], str, Any]): Identifier of the flight's departure terminal.
arrivalTerminal: (Union[List[Union[str, Any]], str, Any]): Identifier of the flight's arrival terminal.
flightNumber: (Union[List[Union[str, Any]], str, Any]): The unique identifier for a flight including the airline IATA code. For example, if describing United flight 110, where the IATA code for United is 'UA', the flightNumber is 'UA110'.
arrivalGate: (Union[List[Union[str, Any]], str, Any]): Identifier of the flight's arrival gate.
aircraft: (Union[List[Union[str, Any]], str, Any]): The kind of aircraft (e.g., "Boeing 747").
"""
type_: str = Field(default="Flight", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
departureTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The expected departure time.",
)
itinerary: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Destination(s) ( [[Place]] ) that make up a trip. For a trip where destination order is"
"important use [[ItemList]] to specify that order (see examples).",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
partOfTrip: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Identifies that this [[Trip]] is a subTrip of another Trip. For example Day 1, Day 2, etc."
"of a multi-day trip.",
)
arrivalTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The expected arrival time.",
)
subTrip: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Identifies a [[Trip]] that is a subTrip of this Trip. For example Day 1, Day 2, etc. of a"
"multi-day trip.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
seller: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An entity which offers (sells / leases / lends / loans) the services / goods. A seller may"
"also be a provider.",
)
boardingPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The type of boarding policy used by the airline (e.g. zone-based or group-based).",
)
webCheckinTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The time when a passenger can check into the flight online.",
)
arrivalAirport: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The airport where the flight terminates.",
)
estimatedFlightDuration: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The estimated time the flight will take.",
)
carrier: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="'carrier' is an out-dated term indicating the 'provider' for parcel delivery and flights.",
)
departureAirport: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The airport where the flight originates.",
)
mealService: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Description of the meals that will be provided or available for purchase.",
)
flightDistance: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The distance of the flight.",
)
departureGate: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the flight's departure gate.",
)
departureTerminal: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the flight's departure terminal.",
)
arrivalTerminal: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the flight's arrival terminal.",
)
flightNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The unique identifier for a flight including the airline IATA code. For example, if describing"
"United flight 110, where the IATA code for United is 'UA', the flightNumber is 'UA110'.",
)
arrivalGate: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the flight's arrival gate.",
)
aircraft: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='The kind of aircraft (e.g., "Boeing 747").',
)
| 0.931595 | 0.464537 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Pond(BaseModel):
"""A pond.
References:
https://schema.org/Pond
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
"""
type_: str = Field(default="Pond", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Pond.py
|
Pond.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Pond(BaseModel):
"""A pond.
References:
https://schema.org/Pond
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
"""
type_: str = Field(default="Pond", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
| 0.948394 | 0.498596 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CT(BaseModel):
"""X-ray computed tomography imaging.
References:
https://schema.org/CT
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="CT", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/CT.py
|
CT.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CT(BaseModel):
"""X-ray computed tomography imaging.
References:
https://schema.org/CT
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="CT", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.938625 | 0.322046 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class UserInteraction(BaseModel):
"""UserInteraction and its subtypes is an old way of talking about users interacting with pages. It is generally better to use [[Action]]-based vocabulary, alongside types such as [[Comment]].
References:
https://schema.org/UserInteraction
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
performer: (Optional[Union[List[Union[str, Any]], str, Any]]): A performer at the event—for example, a presenter, musician, musical group or actor.
eventAttendanceMode: (Optional[Union[List[Union[str, Any]], str, Any]]): The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix.
workFeatured: (Optional[Union[List[Union[str, Any]], str, Any]]): A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).
remainingAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of attendee places for an event that remain unallocated.
actor: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.
doorTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The time admission will commence.
previousStartDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Used in conjunction with eventStatus for rescheduled or cancelled events. This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated.
recordedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The CreativeWork that captured all or part of this Event.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
superEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An event that this event is a part of. For example, a collection of individual music performances might each have a music festival as their superEvent.
eventSchedule: (Optional[Union[List[Union[str, Any]], str, Any]]): Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An [[Event]] that is associated with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]] properties. These are instead defined within the associated [[Schedule]], this avoids any ambiguity for clients using the data. The property might have repeated values to specify different schedules, e.g. for different months or seasons.
maximumVirtualAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).
attendees: (Optional[Union[List[Union[str, Any]], str, Any]]): A person attending the event.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
eventStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
workPerformed: (Optional[Union[List[Union[str, Any]], str, Any]]): A work performed in some event, for example a play performed in a TheaterEvent.
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
composer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who wrote a composition, or who is the composer of a work performed at some event.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
subEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
attendee: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization attending the event.
subEvents: (Optional[Union[List[Union[str, Any]], str, Any]]): Events that are a part of this event. For example, a conference event includes many presentations, each subEvents of the conference.
performers: (Optional[Union[List[Union[str, Any]], str, Any]]): The main performer or performers of the event—for example, a presenter, musician, or actor.
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
maximumPhysicalAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).
director: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
startDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
endDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
organizer: (Optional[Union[List[Union[str, Any]], str, Any]]): An organizer of an Event.
"""
type_: str = Field(default="UserInteraction", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
performer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A performer at the event—for example, a presenter, musician, musical group"
"or actor.",
)
eventAttendanceMode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The eventAttendanceMode of an event indicates whether it occurs online, offline, or"
"a mix.",
)
workFeatured: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties"
"are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).",
)
remainingAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The number of attendee places for an event that remain unallocated.",
)
actor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated"
"with individual items or with a series, episode, clip.",
)
doorTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The time admission will commence.",
)
previousStartDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Used in conjunction with eventStatus for rescheduled or cancelled events. This property"
"contains the previously scheduled start date. For rescheduled events, the startDate"
"property should be used for the newly scheduled start date. In the (rare) case of an event"
"that has been postponed and rescheduled multiple times, this field may be repeated.",
)
recordedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The CreativeWork that captured all or part of this Event.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
superEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An event that this event is a part of. For example, a collection of individual music performances"
"might each have a music festival as their superEvent.",
)
eventSchedule: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable"
"to share a schedule for a series of repeating events rather than data on the individual"
"events themselves. For example, a website or application might prefer to publish a schedule"
"for a weekly gym class rather than provide data on every event. A schedule could be processed"
"by applications to add forthcoming events to a calendar. An [[Event]] that is associated"
"with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]]"
"properties. These are instead defined within the associated [[Schedule]], this avoids"
"any ambiguity for clients using the data. The property might have repeated values to"
"specify different schedules, e.g. for different months or seasons.",
)
maximumVirtualAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
attendees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person attending the event.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
eventStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An eventStatus of an event represents its status; particularly useful when an event"
"is cancelled or rescheduled.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
workPerformed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work performed in some event, for example a play performed in a TheaterEvent.",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
composer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who wrote a composition, or who is the composer of a work performed"
"at some event.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
subEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Event that is part of this event. For example, a conference event includes many presentations,"
"each of which is a subEvent of the conference.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
attendee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization attending the event.",
)
subEvents: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Events that are a part of this event. For example, a conference event includes many presentations,"
"each subEvents of the conference.",
)
performers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The main performer or performers of the event—for example, a presenter, musician,"
"or actor.",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
maximumPhysicalAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
director: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors"
"can be associated with individual items or with a series, episode, clip.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
startDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
endDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
organizer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An organizer of an Event.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/UserInteraction.py
|
UserInteraction.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class UserInteraction(BaseModel):
"""UserInteraction and its subtypes is an old way of talking about users interacting with pages. It is generally better to use [[Action]]-based vocabulary, alongside types such as [[Comment]].
References:
https://schema.org/UserInteraction
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
performer: (Optional[Union[List[Union[str, Any]], str, Any]]): A performer at the event—for example, a presenter, musician, musical group or actor.
eventAttendanceMode: (Optional[Union[List[Union[str, Any]], str, Any]]): The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix.
workFeatured: (Optional[Union[List[Union[str, Any]], str, Any]]): A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).
remainingAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of attendee places for an event that remain unallocated.
actor: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.
doorTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The time admission will commence.
previousStartDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Used in conjunction with eventStatus for rescheduled or cancelled events. This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated.
recordedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The CreativeWork that captured all or part of this Event.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
superEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An event that this event is a part of. For example, a collection of individual music performances might each have a music festival as their superEvent.
eventSchedule: (Optional[Union[List[Union[str, Any]], str, Any]]): Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An [[Event]] that is associated with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]] properties. These are instead defined within the associated [[Schedule]], this avoids any ambiguity for clients using the data. The property might have repeated values to specify different schedules, e.g. for different months or seasons.
maximumVirtualAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).
attendees: (Optional[Union[List[Union[str, Any]], str, Any]]): A person attending the event.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
eventStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
workPerformed: (Optional[Union[List[Union[str, Any]], str, Any]]): A work performed in some event, for example a play performed in a TheaterEvent.
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
composer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who wrote a composition, or who is the composer of a work performed at some event.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
subEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
attendee: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization attending the event.
subEvents: (Optional[Union[List[Union[str, Any]], str, Any]]): Events that are a part of this event. For example, a conference event includes many presentations, each subEvents of the conference.
performers: (Optional[Union[List[Union[str, Any]], str, Any]]): The main performer or performers of the event—for example, a presenter, musician, or actor.
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
maximumPhysicalAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).
director: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
startDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
endDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
organizer: (Optional[Union[List[Union[str, Any]], str, Any]]): An organizer of an Event.
"""
type_: str = Field(default="UserInteraction", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
performer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A performer at the event—for example, a presenter, musician, musical group"
"or actor.",
)
eventAttendanceMode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The eventAttendanceMode of an event indicates whether it occurs online, offline, or"
"a mix.",
)
workFeatured: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties"
"are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).",
)
remainingAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The number of attendee places for an event that remain unallocated.",
)
actor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated"
"with individual items or with a series, episode, clip.",
)
doorTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The time admission will commence.",
)
previousStartDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Used in conjunction with eventStatus for rescheduled or cancelled events. This property"
"contains the previously scheduled start date. For rescheduled events, the startDate"
"property should be used for the newly scheduled start date. In the (rare) case of an event"
"that has been postponed and rescheduled multiple times, this field may be repeated.",
)
recordedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The CreativeWork that captured all or part of this Event.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
superEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An event that this event is a part of. For example, a collection of individual music performances"
"might each have a music festival as their superEvent.",
)
eventSchedule: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable"
"to share a schedule for a series of repeating events rather than data on the individual"
"events themselves. For example, a website or application might prefer to publish a schedule"
"for a weekly gym class rather than provide data on every event. A schedule could be processed"
"by applications to add forthcoming events to a calendar. An [[Event]] that is associated"
"with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]]"
"properties. These are instead defined within the associated [[Schedule]], this avoids"
"any ambiguity for clients using the data. The property might have repeated values to"
"specify different schedules, e.g. for different months or seasons.",
)
maximumVirtualAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
attendees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person attending the event.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
eventStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An eventStatus of an event represents its status; particularly useful when an event"
"is cancelled or rescheduled.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
workPerformed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work performed in some event, for example a play performed in a TheaterEvent.",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
composer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who wrote a composition, or who is the composer of a work performed"
"at some event.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
subEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Event that is part of this event. For example, a conference event includes many presentations,"
"each of which is a subEvent of the conference.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
attendee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization attending the event.",
)
subEvents: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Events that are a part of this event. For example, a conference event includes many presentations,"
"each subEvents of the conference.",
)
performers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The main performer or performers of the event—for example, a presenter, musician,"
"or actor.",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
maximumPhysicalAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
director: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors"
"can be associated with individual items or with a series, episode, clip.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
startDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
endDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
organizer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An organizer of an Event.",
)
| 0.921503 | 0.305304 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PeopleAudience(BaseModel):
"""A set of characteristics belonging to people, e.g. who compose an item's target audience.
References:
https://schema.org/PeopleAudience
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
audienceType: (Union[List[Union[str, Any]], str, Any]): The target group associated with a given audience (e.g. veterans, car owners, musicians, etc.).
geographicArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area associated with the audience.
healthCondition: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifying the health condition(s) of a patient, medical study, or other target audience.
requiredGender: (Union[List[Union[str, Any]], str, Any]): Audiences defined by a person's gender.
suggestedMinAge: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): Minimum recommended age in years for the audience or user.
requiredMinAge: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): Audiences defined by a person's minimum age.
suggestedMeasurement: (Optional[Union[List[Union[str, Any]], str, Any]]): A suggested range of body measurements for the intended audience or person, for example inseam between 32 and 34 inches or height between 170 and 190 cm. Typically found on a size chart for wearable products.
suggestedGender: (Union[List[Union[str, Any]], str, Any]): The suggested gender of the intended person or audience, for example "male", "female", or "unisex".
requiredMaxAge: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): Audiences defined by a person's maximum age.
suggestedAge: (Optional[Union[List[Union[str, Any]], str, Any]]): The age or age range for the intended audience or person, for example 3-12 months for infants, 1-5 years for toddlers.
suggestedMaxAge: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): Maximum recommended age in years for the audience or user.
"""
type_: str = Field(default="PeopleAudience", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
audienceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The target group associated with a given audience (e.g. veterans, car owners, musicians,"
"etc.).",
)
geographicArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area associated with the audience.",
)
healthCondition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifying the health condition(s) of a patient, medical study, or other target audience.",
)
requiredGender: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Audiences defined by a person's gender.",
)
suggestedMinAge: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="Minimum recommended age in years for the audience or user.",
)
requiredMinAge: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="Audiences defined by a person's minimum age.",
)
suggestedMeasurement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A suggested range of body measurements for the intended audience or person, for example"
"inseam between 32 and 34 inches or height between 170 and 190 cm. Typically found on a size"
"chart for wearable products.",
)
suggestedGender: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='The suggested gender of the intended person or audience, for example "male", "female",'
'or "unisex".',
)
requiredMaxAge: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="Audiences defined by a person's maximum age.",
)
suggestedAge: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The age or age range for the intended audience or person, for example 3-12 months for infants,"
"1-5 years for toddlers.",
)
suggestedMaxAge: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="Maximum recommended age in years for the audience or user.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/PeopleAudience.py
|
PeopleAudience.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PeopleAudience(BaseModel):
"""A set of characteristics belonging to people, e.g. who compose an item's target audience.
References:
https://schema.org/PeopleAudience
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
audienceType: (Union[List[Union[str, Any]], str, Any]): The target group associated with a given audience (e.g. veterans, car owners, musicians, etc.).
geographicArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area associated with the audience.
healthCondition: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifying the health condition(s) of a patient, medical study, or other target audience.
requiredGender: (Union[List[Union[str, Any]], str, Any]): Audiences defined by a person's gender.
suggestedMinAge: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): Minimum recommended age in years for the audience or user.
requiredMinAge: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): Audiences defined by a person's minimum age.
suggestedMeasurement: (Optional[Union[List[Union[str, Any]], str, Any]]): A suggested range of body measurements for the intended audience or person, for example inseam between 32 and 34 inches or height between 170 and 190 cm. Typically found on a size chart for wearable products.
suggestedGender: (Union[List[Union[str, Any]], str, Any]): The suggested gender of the intended person or audience, for example "male", "female", or "unisex".
requiredMaxAge: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): Audiences defined by a person's maximum age.
suggestedAge: (Optional[Union[List[Union[str, Any]], str, Any]]): The age or age range for the intended audience or person, for example 3-12 months for infants, 1-5 years for toddlers.
suggestedMaxAge: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): Maximum recommended age in years for the audience or user.
"""
type_: str = Field(default="PeopleAudience", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
audienceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The target group associated with a given audience (e.g. veterans, car owners, musicians,"
"etc.).",
)
geographicArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area associated with the audience.",
)
healthCondition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifying the health condition(s) of a patient, medical study, or other target audience.",
)
requiredGender: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Audiences defined by a person's gender.",
)
suggestedMinAge: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="Minimum recommended age in years for the audience or user.",
)
requiredMinAge: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="Audiences defined by a person's minimum age.",
)
suggestedMeasurement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A suggested range of body measurements for the intended audience or person, for example"
"inseam between 32 and 34 inches or height between 170 and 190 cm. Typically found on a size"
"chart for wearable products.",
)
suggestedGender: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='The suggested gender of the intended person or audience, for example "male", "female",'
'or "unisex".',
)
requiredMaxAge: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="Audiences defined by a person's maximum age.",
)
suggestedAge: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The age or age range for the intended audience or person, for example 3-12 months for infants,"
"1-5 years for toddlers.",
)
suggestedMaxAge: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="Maximum recommended age in years for the audience or user.",
)
| 0.940182 | 0.327924 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class XPathType(BaseModel):
"""Text representing an XPath (typically but not necessarily version 1.0).
References:
https://schema.org/XPathType
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="XPathType", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/XPathType.py
|
XPathType.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class XPathType(BaseModel):
"""Text representing an XPath (typically but not necessarily version 1.0).
References:
https://schema.org/XPathType
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="XPathType", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.944151 | 0.32158 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c26(BaseModel):
"""Nonprofit501c26: Non-profit type referring to State-Sponsored Organizations Providing Health Coverage for High-Risk Individuals.
References:
https://schema.org/Nonprofit501c26
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Nonprofit501c26", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Nonprofit501c26.py
|
Nonprofit501c26.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c26(BaseModel):
"""Nonprofit501c26: Non-profit type referring to State-Sponsored Organizations Providing Health Coverage for High-Risk Individuals.
References:
https://schema.org/Nonprofit501c26
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Nonprofit501c26", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.945776 | 0.26159 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HomeGoodsStore(BaseModel):
"""A home goods store.
References:
https://schema.org/HomeGoodsStore
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
priceRange: (Union[List[Union[str, Any]], str, Any]): The price range of the business, for example ```$$$```.
currenciesAccepted: (Union[List[Union[str, Any]], str, Any]): The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
branchOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].
paymentAccepted: (Union[List[Union[str, Any]], str, Any]): Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
"""
type_: str = Field(default="HomeGoodsStore", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
priceRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The price range of the business, for example ```$$$```.",
)
currenciesAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217),"
'e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)'
'for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
branchOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this local business is a branch of, if any. Not to be confused"
"with (anatomical) [[branch]].",
)
paymentAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/HomeGoodsStore.py
|
HomeGoodsStore.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HomeGoodsStore(BaseModel):
"""A home goods store.
References:
https://schema.org/HomeGoodsStore
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
priceRange: (Union[List[Union[str, Any]], str, Any]): The price range of the business, for example ```$$$```.
currenciesAccepted: (Union[List[Union[str, Any]], str, Any]): The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
branchOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].
paymentAccepted: (Union[List[Union[str, Any]], str, Any]): Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
"""
type_: str = Field(default="HomeGoodsStore", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
priceRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The price range of the business, for example ```$$$```.",
)
currenciesAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217),"
'e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)'
'for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
branchOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this local business is a branch of, if any. Not to be confused"
"with (anatomical) [[branch]].",
)
paymentAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
| 0.868255 | 0.359842 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Endocrine(BaseModel):
"""A specific branch of medical science that pertains to diagnosis and treatment of disorders of endocrine glands and their secretions.
References:
https://schema.org/Endocrine
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Endocrine", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Endocrine.py
|
Endocrine.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Endocrine(BaseModel):
"""A specific branch of medical science that pertains to diagnosis and treatment of disorders of endocrine glands and their secretions.
References:
https://schema.org/Endocrine
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Endocrine", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.929584 | 0.392337 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DrugCost(BaseModel):
"""The cost per unit of a medical drug. Note that this type is not meant to represent the price in an offer of a drug for sale; see the Offer type for that. This type will typically be used to tag wholesale or average retail cost of a drug, or maximum reimbursable cost. Costs of medical drugs vary widely depending on how and where they are paid for, so while this type captures some of the variables, costs should be used with caution by consumers of this schema's markup.
References:
https://schema.org/DrugCost
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
recognizingAuthority: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.
relevantSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, a medical specialty in which this entity is relevant.
medicineSystem: (Optional[Union[List[Union[str, Any]], str, Any]]): The system of medicine that includes this MedicalEntity, for example 'evidence-based', 'homeopathic', 'chiropractic', etc.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
legalStatus: (Union[List[Union[str, Any]], str, Any]): The drug or supplement's legal status, including any controlled substance schedules that apply.
study: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical study or trial related to this entity.
guideline: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical guideline related to this entity.
code: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
costPerUnit: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The cost per unit of the drug.
applicableLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location in which the status applies.
drugUnit: (Union[List[Union[str, Any]], str, Any]): The unit in which the drug is measured, e.g. '5 mg tablet'.
costOrigin: (Union[List[Union[str, Any]], str, Any]): Additional details to capture the origin of the cost data. For example, 'Medicare Part B'.
costCategory: (Optional[Union[List[Union[str, Any]], str, Any]]): The category of cost, such as wholesale, retail, reimbursement cap, etc.
costCurrency: (Union[List[Union[str, Any]], str, Any]): The currency (in 3-letter) of the drug cost. See: http://en.wikipedia.org/wiki/ISO_4217.
"""
type_: str = Field(default="DrugCost", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
recognizingAuthority: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, the organization that officially recognizes this entity as part of its"
"endorsed system of medicine.",
)
relevantSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, a medical specialty in which this entity is relevant.",
)
medicineSystem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The system of medicine that includes this MedicalEntity, for example 'evidence-based',"
"'homeopathic', 'chiropractic', etc.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
legalStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The drug or supplement's legal status, including any controlled substance schedules"
"that apply.",
)
study: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical study or trial related to this entity.",
)
guideline: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical guideline related to this entity.",
)
code: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical code for the entity, taken from a controlled vocabulary or ontology such as"
"ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.",
)
costPerUnit: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The cost per unit of the drug.",
)
applicableLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location in which the status applies.",
)
drugUnit: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The unit in which the drug is measured, e.g. '5 mg tablet'.",
)
costOrigin: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Additional details to capture the origin of the cost data. For example, 'Medicare Part"
"B'.",
)
costCategory: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The category of cost, such as wholesale, retail, reimbursement cap, etc.",
)
costCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency (in 3-letter) of the drug cost. See: http://en.wikipedia.org/wiki/ISO_4217.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/DrugCost.py
|
DrugCost.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DrugCost(BaseModel):
"""The cost per unit of a medical drug. Note that this type is not meant to represent the price in an offer of a drug for sale; see the Offer type for that. This type will typically be used to tag wholesale or average retail cost of a drug, or maximum reimbursable cost. Costs of medical drugs vary widely depending on how and where they are paid for, so while this type captures some of the variables, costs should be used with caution by consumers of this schema's markup.
References:
https://schema.org/DrugCost
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
recognizingAuthority: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.
relevantSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, a medical specialty in which this entity is relevant.
medicineSystem: (Optional[Union[List[Union[str, Any]], str, Any]]): The system of medicine that includes this MedicalEntity, for example 'evidence-based', 'homeopathic', 'chiropractic', etc.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
legalStatus: (Union[List[Union[str, Any]], str, Any]): The drug or supplement's legal status, including any controlled substance schedules that apply.
study: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical study or trial related to this entity.
guideline: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical guideline related to this entity.
code: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
costPerUnit: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The cost per unit of the drug.
applicableLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location in which the status applies.
drugUnit: (Union[List[Union[str, Any]], str, Any]): The unit in which the drug is measured, e.g. '5 mg tablet'.
costOrigin: (Union[List[Union[str, Any]], str, Any]): Additional details to capture the origin of the cost data. For example, 'Medicare Part B'.
costCategory: (Optional[Union[List[Union[str, Any]], str, Any]]): The category of cost, such as wholesale, retail, reimbursement cap, etc.
costCurrency: (Union[List[Union[str, Any]], str, Any]): The currency (in 3-letter) of the drug cost. See: http://en.wikipedia.org/wiki/ISO_4217.
"""
type_: str = Field(default="DrugCost", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
recognizingAuthority: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, the organization that officially recognizes this entity as part of its"
"endorsed system of medicine.",
)
relevantSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, a medical specialty in which this entity is relevant.",
)
medicineSystem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The system of medicine that includes this MedicalEntity, for example 'evidence-based',"
"'homeopathic', 'chiropractic', etc.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
legalStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The drug or supplement's legal status, including any controlled substance schedules"
"that apply.",
)
study: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical study or trial related to this entity.",
)
guideline: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical guideline related to this entity.",
)
code: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical code for the entity, taken from a controlled vocabulary or ontology such as"
"ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.",
)
costPerUnit: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The cost per unit of the drug.",
)
applicableLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location in which the status applies.",
)
drugUnit: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The unit in which the drug is measured, e.g. '5 mg tablet'.",
)
costOrigin: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Additional details to capture the origin of the cost data. For example, 'Medicare Part"
"B'.",
)
costCategory: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The category of cost, such as wholesale, retail, reimbursement cap, etc.",
)
costCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency (in 3-letter) of the drug cost. See: http://en.wikipedia.org/wiki/ISO_4217.",
)
| 0.944728 | 0.47244 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EventSeries(BaseModel):
"""A series of [[Event]]s. Included events can relate with the series using the [[superEvent]] property.An EventSeries is a collection of events that share some unifying characteristic. For example, "The Olympic Games" is a series, whichis repeated regularly. The "2012 London Olympics" can be presented both as an [[Event]] in the series "Olympic Games", and as an[[EventSeries]] that included a number of sporting competitions as Events.The nature of the association between the events in an [[EventSeries]] can vary, but typical examples couldinclude a thematic event series (e.g. topical meetups or classes), or a series of regular events that share a location, attendee group and/or organizers.EventSeries has been defined as a kind of Event to make it easy for publishers to use it in an Event context withoutworrying about which kinds of series are really event-like enough to call an Event. In general an EventSeriesmay seem more Event-like when the period of time is compact and when aspects such as location are fixed, butit may also sometimes prove useful to describe a longer-term series as an Event.
References:
https://schema.org/EventSeries
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
performer: (Optional[Union[List[Union[str, Any]], str, Any]]): A performer at the event—for example, a presenter, musician, musical group or actor.
eventAttendanceMode: (Optional[Union[List[Union[str, Any]], str, Any]]): The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix.
workFeatured: (Optional[Union[List[Union[str, Any]], str, Any]]): A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).
remainingAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of attendee places for an event that remain unallocated.
actor: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.
doorTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The time admission will commence.
previousStartDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Used in conjunction with eventStatus for rescheduled or cancelled events. This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated.
recordedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The CreativeWork that captured all or part of this Event.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
superEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An event that this event is a part of. For example, a collection of individual music performances might each have a music festival as their superEvent.
eventSchedule: (Optional[Union[List[Union[str, Any]], str, Any]]): Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An [[Event]] that is associated with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]] properties. These are instead defined within the associated [[Schedule]], this avoids any ambiguity for clients using the data. The property might have repeated values to specify different schedules, e.g. for different months or seasons.
maximumVirtualAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).
attendees: (Optional[Union[List[Union[str, Any]], str, Any]]): A person attending the event.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
eventStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
workPerformed: (Optional[Union[List[Union[str, Any]], str, Any]]): A work performed in some event, for example a play performed in a TheaterEvent.
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
composer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who wrote a composition, or who is the composer of a work performed at some event.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
subEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
attendee: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization attending the event.
subEvents: (Optional[Union[List[Union[str, Any]], str, Any]]): Events that are a part of this event. For example, a conference event includes many presentations, each subEvents of the conference.
performers: (Optional[Union[List[Union[str, Any]], str, Any]]): The main performer or performers of the event—for example, a presenter, musician, or actor.
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
maximumPhysicalAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).
director: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
startDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
endDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
organizer: (Optional[Union[List[Union[str, Any]], str, Any]]): An organizer of an Event.
"""
type_: str = Field(default="EventSeries", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
performer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A performer at the event—for example, a presenter, musician, musical group"
"or actor.",
)
eventAttendanceMode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The eventAttendanceMode of an event indicates whether it occurs online, offline, or"
"a mix.",
)
workFeatured: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties"
"are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).",
)
remainingAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The number of attendee places for an event that remain unallocated.",
)
actor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated"
"with individual items or with a series, episode, clip.",
)
doorTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The time admission will commence.",
)
previousStartDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Used in conjunction with eventStatus for rescheduled or cancelled events. This property"
"contains the previously scheduled start date. For rescheduled events, the startDate"
"property should be used for the newly scheduled start date. In the (rare) case of an event"
"that has been postponed and rescheduled multiple times, this field may be repeated.",
)
recordedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The CreativeWork that captured all or part of this Event.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
superEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An event that this event is a part of. For example, a collection of individual music performances"
"might each have a music festival as their superEvent.",
)
eventSchedule: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable"
"to share a schedule for a series of repeating events rather than data on the individual"
"events themselves. For example, a website or application might prefer to publish a schedule"
"for a weekly gym class rather than provide data on every event. A schedule could be processed"
"by applications to add forthcoming events to a calendar. An [[Event]] that is associated"
"with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]]"
"properties. These are instead defined within the associated [[Schedule]], this avoids"
"any ambiguity for clients using the data. The property might have repeated values to"
"specify different schedules, e.g. for different months or seasons.",
)
maximumVirtualAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
attendees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person attending the event.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
eventStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An eventStatus of an event represents its status; particularly useful when an event"
"is cancelled or rescheduled.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
workPerformed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work performed in some event, for example a play performed in a TheaterEvent.",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
composer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who wrote a composition, or who is the composer of a work performed"
"at some event.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
subEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Event that is part of this event. For example, a conference event includes many presentations,"
"each of which is a subEvent of the conference.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
attendee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization attending the event.",
)
subEvents: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Events that are a part of this event. For example, a conference event includes many presentations,"
"each subEvents of the conference.",
)
performers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The main performer or performers of the event—for example, a presenter, musician,"
"or actor.",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
maximumPhysicalAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
director: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors"
"can be associated with individual items or with a series, episode, clip.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
startDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
endDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
organizer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An organizer of an Event.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/EventSeries.py
|
EventSeries.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EventSeries(BaseModel):
"""A series of [[Event]]s. Included events can relate with the series using the [[superEvent]] property.An EventSeries is a collection of events that share some unifying characteristic. For example, "The Olympic Games" is a series, whichis repeated regularly. The "2012 London Olympics" can be presented both as an [[Event]] in the series "Olympic Games", and as an[[EventSeries]] that included a number of sporting competitions as Events.The nature of the association between the events in an [[EventSeries]] can vary, but typical examples couldinclude a thematic event series (e.g. topical meetups or classes), or a series of regular events that share a location, attendee group and/or organizers.EventSeries has been defined as a kind of Event to make it easy for publishers to use it in an Event context withoutworrying about which kinds of series are really event-like enough to call an Event. In general an EventSeriesmay seem more Event-like when the period of time is compact and when aspects such as location are fixed, butit may also sometimes prove useful to describe a longer-term series as an Event.
References:
https://schema.org/EventSeries
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
performer: (Optional[Union[List[Union[str, Any]], str, Any]]): A performer at the event—for example, a presenter, musician, musical group or actor.
eventAttendanceMode: (Optional[Union[List[Union[str, Any]], str, Any]]): The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix.
workFeatured: (Optional[Union[List[Union[str, Any]], str, Any]]): A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).
remainingAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of attendee places for an event that remain unallocated.
actor: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.
doorTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The time admission will commence.
previousStartDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Used in conjunction with eventStatus for rescheduled or cancelled events. This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated.
recordedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The CreativeWork that captured all or part of this Event.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
superEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An event that this event is a part of. For example, a collection of individual music performances might each have a music festival as their superEvent.
eventSchedule: (Optional[Union[List[Union[str, Any]], str, Any]]): Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An [[Event]] that is associated with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]] properties. These are instead defined within the associated [[Schedule]], this avoids any ambiguity for clients using the data. The property might have repeated values to specify different schedules, e.g. for different months or seasons.
maximumVirtualAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).
attendees: (Optional[Union[List[Union[str, Any]], str, Any]]): A person attending the event.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
eventStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
workPerformed: (Optional[Union[List[Union[str, Any]], str, Any]]): A work performed in some event, for example a play performed in a TheaterEvent.
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
composer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who wrote a composition, or who is the composer of a work performed at some event.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
subEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
attendee: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization attending the event.
subEvents: (Optional[Union[List[Union[str, Any]], str, Any]]): Events that are a part of this event. For example, a conference event includes many presentations, each subEvents of the conference.
performers: (Optional[Union[List[Union[str, Any]], str, Any]]): The main performer or performers of the event—for example, a presenter, musician, or actor.
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
maximumPhysicalAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).
director: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
startDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
endDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
organizer: (Optional[Union[List[Union[str, Any]], str, Any]]): An organizer of an Event.
"""
type_: str = Field(default="EventSeries", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
performer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A performer at the event—for example, a presenter, musician, musical group"
"or actor.",
)
eventAttendanceMode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The eventAttendanceMode of an event indicates whether it occurs online, offline, or"
"a mix.",
)
workFeatured: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties"
"are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).",
)
remainingAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The number of attendee places for an event that remain unallocated.",
)
actor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated"
"with individual items or with a series, episode, clip.",
)
doorTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The time admission will commence.",
)
previousStartDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Used in conjunction with eventStatus for rescheduled or cancelled events. This property"
"contains the previously scheduled start date. For rescheduled events, the startDate"
"property should be used for the newly scheduled start date. In the (rare) case of an event"
"that has been postponed and rescheduled multiple times, this field may be repeated.",
)
recordedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The CreativeWork that captured all or part of this Event.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
superEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An event that this event is a part of. For example, a collection of individual music performances"
"might each have a music festival as their superEvent.",
)
eventSchedule: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable"
"to share a schedule for a series of repeating events rather than data on the individual"
"events themselves. For example, a website or application might prefer to publish a schedule"
"for a weekly gym class rather than provide data on every event. A schedule could be processed"
"by applications to add forthcoming events to a calendar. An [[Event]] that is associated"
"with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]]"
"properties. These are instead defined within the associated [[Schedule]], this avoids"
"any ambiguity for clients using the data. The property might have repeated values to"
"specify different schedules, e.g. for different months or seasons.",
)
maximumVirtualAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
attendees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person attending the event.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
eventStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An eventStatus of an event represents its status; particularly useful when an event"
"is cancelled or rescheduled.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
workPerformed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work performed in some event, for example a play performed in a TheaterEvent.",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
composer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who wrote a composition, or who is the composer of a work performed"
"at some event.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
subEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Event that is part of this event. For example, a conference event includes many presentations,"
"each of which is a subEvent of the conference.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
attendee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization attending the event.",
)
subEvents: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Events that are a part of this event. For example, a conference event includes many presentations,"
"each subEvents of the conference.",
)
performers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The main performer or performers of the event—for example, a presenter, musician,"
"or actor.",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
maximumPhysicalAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
director: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors"
"can be associated with individual items or with a series, episode, clip.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
startDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
endDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
organizer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An organizer of an Event.",
)
| 0.907717 | 0.648605 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SiteNavigationElement(BaseModel):
"""A navigation element of the page.
References:
https://schema.org/SiteNavigationElement
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
xpath: (Union[List[Union[str, Any]], str, Any]): An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
cssSelector: (Union[List[Union[str, Any]], str, Any]): A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
"""
type_: str = Field(default="SiteNavigationElement", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
xpath: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter"
'case, multiple matches within a page can constitute a single conceptual "Web page element".',
)
cssSelector: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the"
'latter case, multiple matches within a page can constitute a single conceptual "Web'
'page element".',
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/SiteNavigationElement.py
|
SiteNavigationElement.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SiteNavigationElement(BaseModel):
"""A navigation element of the page.
References:
https://schema.org/SiteNavigationElement
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
xpath: (Union[List[Union[str, Any]], str, Any]): An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
cssSelector: (Union[List[Union[str, Any]], str, Any]): A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
"""
type_: str = Field(default="SiteNavigationElement", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
xpath: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter"
'case, multiple matches within a page can constitute a single conceptual "Web page element".',
)
cssSelector: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the"
'latter case, multiple matches within a page can constitute a single conceptual "Web'
'page element".',
)
| 0.932323 | 0.324128 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CorrectionComment(BaseModel):
"""A [[comment]] that corrects [[CreativeWork]].
References:
https://schema.org/CorrectionComment
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
parentItem: (Optional[Union[List[Union[str, Any]], str, Any]]): The parent of a question, answer or item in general.
downvoteCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of downvotes this question, answer or comment has received from the community.
upvoteCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of upvotes this question, answer or comment has received from the community.
"""
type_: str = Field(default="CorrectionComment", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
parentItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The parent of a question, answer or item in general.",
)
downvoteCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of downvotes this question, answer or comment has received from the community.",
)
upvoteCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of upvotes this question, answer or comment has received from the community.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/CorrectionComment.py
|
CorrectionComment.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CorrectionComment(BaseModel):
"""A [[comment]] that corrects [[CreativeWork]].
References:
https://schema.org/CorrectionComment
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
parentItem: (Optional[Union[List[Union[str, Any]], str, Any]]): The parent of a question, answer or item in general.
downvoteCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of downvotes this question, answer or comment has received from the community.
upvoteCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of upvotes this question, answer or comment has received from the community.
"""
type_: str = Field(default="CorrectionComment", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
parentItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The parent of a question, answer or item in general.",
)
downvoteCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of downvotes this question, answer or comment has received from the community.",
)
upvoteCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of upvotes this question, answer or comment has received from the community.",
)
| 0.928088 | 0.322126 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CDFormat(BaseModel):
"""CDFormat.
References:
https://schema.org/CDFormat
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="CDFormat", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/CDFormat.py
|
CDFormat.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CDFormat(BaseModel):
"""CDFormat.
References:
https://schema.org/CDFormat
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="CDFormat", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.938513 | 0.304468 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EBook(BaseModel):
"""Book format: Ebook.
References:
https://schema.org/EBook
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="EBook", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/EBook.py
|
EBook.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EBook(BaseModel):
"""Book format: Ebook.
References:
https://schema.org/EBook
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="EBook", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.941196 | 0.308672 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Volcano(BaseModel):
"""A volcano, like Fujisan.
References:
https://schema.org/Volcano
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
"""
type_: str = Field(default="Volcano", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Volcano.py
|
Volcano.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Volcano(BaseModel):
"""A volcano, like Fujisan.
References:
https://schema.org/Volcano
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
"""
type_: str = Field(default="Volcano", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
| 0.94528 | 0.526221 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Flexibility(BaseModel):
"""Physical activity that is engaged in to improve joint and muscle flexibility.
References:
https://schema.org/Flexibility
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Flexibility", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Flexibility.py
|
Flexibility.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Flexibility(BaseModel):
"""Physical activity that is engaged in to improve joint and muscle flexibility.
References:
https://schema.org/Flexibility
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Flexibility", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.943315 | 0.317241 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HyperToc(BaseModel):
"""A HyperToc represents a hypertext table of contents for complex media objects, such as [[VideoObject]], [[AudioObject]]. Items in the table of contents are indicated using the [[tocEntry]] property, and typed [[HyperTocEntry]]. For cases where the same larger work is split into multiple files, [[associatedMedia]] can be used on individual [[HyperTocEntry]] items.
References:
https://schema.org/HyperToc
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
tocEntry: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a [[HyperTocEntry]] in a [[HyperToc]].
"""
type_: str = Field(default="HyperToc", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
tocEntry: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a [[HyperTocEntry]] in a [[HyperToc]].",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/HyperToc.py
|
HyperToc.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HyperToc(BaseModel):
"""A HyperToc represents a hypertext table of contents for complex media objects, such as [[VideoObject]], [[AudioObject]]. Items in the table of contents are indicated using the [[tocEntry]] property, and typed [[HyperTocEntry]]. For cases where the same larger work is split into multiple files, [[associatedMedia]] can be used on individual [[HyperTocEntry]] items.
References:
https://schema.org/HyperToc
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
tocEntry: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a [[HyperTocEntry]] in a [[HyperToc]].
"""
type_: str = Field(default="HyperToc", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
tocEntry: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a [[HyperTocEntry]] in a [[HyperToc]].",
)
| 0.916978 | 0.404449 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class InvoicePrice(BaseModel):
"""Represents the invoice price of an offered product.
References:
https://schema.org/InvoicePrice
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="InvoicePrice", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/InvoicePrice.py
|
InvoicePrice.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class InvoicePrice(BaseModel):
"""Represents the invoice price of an offered product.
References:
https://schema.org/InvoicePrice
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="InvoicePrice", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.94419 | 0.33876 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EffectivenessHealthAspect(BaseModel):
"""Content about the effectiveness-related aspects of a health topic.
References:
https://schema.org/EffectivenessHealthAspect
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="EffectivenessHealthAspect", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/EffectivenessHealthAspect.py
|
EffectivenessHealthAspect.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EffectivenessHealthAspect(BaseModel):
"""Content about the effectiveness-related aspects of a health topic.
References:
https://schema.org/EffectivenessHealthAspect
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="EffectivenessHealthAspect", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.947854 | 0.335378 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Article(BaseModel):
"""An article, such as a news article or piece of investigative report. Newspapers and magazines have articles of many different types and this is intended to cover them all.See also [blog post](http://blog.schema.org/2014/09/schemaorg-support-for-bibliographic_2.html).
References:
https://schema.org/Article
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
pageEnd: (Union[List[Union[str, int, Any]], str, int, Any]): The page on which the work ends; for example "138" or "xvi".
wordCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of words in the text of the Article.
articleSection: (Union[List[Union[str, Any]], str, Any]): Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc.
articleBody: (Union[List[Union[str, Any]], str, Any]): The actual body of the article.
speakable: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.The *speakable* property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:1.) *id-value* URL references - uses *id-value* of an element in the page being annotated. The simplest use of *speakable* has (potentially relative) URL values, referencing identified sections of the document concerned.2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property.For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the *speakable* property.
backstory: (Union[List[Union[str, Any]], str, Any]): For an [[Article]], typically a [[NewsArticle]], the backstory property provides a textual summary giving a brief explanation of why and how an article was created. In a journalistic setting this could include information about reporting process, methods, interviews, data sources, etc.
pagination: (Union[List[Union[str, Any]], str, Any]): Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49".
pageStart: (Union[List[Union[str, int, Any]], str, int, Any]): The page on which the work starts; for example "135" or "xiii".
"""
type_: str = Field(default="Article", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
pageEnd: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description='The page on which the work ends; for example "138" or "xvi".',
)
wordCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of words in the text of the Article.",
)
articleSection: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports,"
"Lifestyle, etc.",
)
articleBody: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The actual body of the article.",
)
speakable: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates sections of a Web page that are particularly 'speakable' in the sense of being"
"highlighted as being especially appropriate for text-to-speech conversion. Other"
"sections of a page may also be usefully spoken in particular circumstances; the 'speakable'"
"property serves to indicate the parts most likely to be generally useful for speech.The"
"*speakable* property can be repeated an arbitrary number of times, with three kinds"
"of possible 'content-locator' values:1.) *id-value* URL references - uses *id-value*"
"of an element in the page being annotated. The simplest use of *speakable* has (potentially"
"relative) URL values, referencing identified sections of the document concerned.2.)"
"CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use"
"the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming"
"an XML view of the content). Use the [[xpath]] property.For more sophisticated markup"
"of speakable sections beyond simple ID references, either CSS selectors or XPath expressions"
"to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]]"
"which is defined to be a possible value of the *speakable* property.",
)
backstory: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="For an [[Article]], typically a [[NewsArticle]], the backstory property provides"
"a textual summary giving a brief explanation of why and how an article was created. In"
"a journalistic setting this could include information about reporting process, methods,"
"interviews, data sources, etc.",
)
pagination: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Any description of pages that is not separated into pageStart and pageEnd; for example,"
'"1-6, 9, 55" or "10-12, 46-49".',
)
pageStart: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description='The page on which the work starts; for example "135" or "xiii".',
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Article.py
|
Article.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Article(BaseModel):
"""An article, such as a news article or piece of investigative report. Newspapers and magazines have articles of many different types and this is intended to cover them all.See also [blog post](http://blog.schema.org/2014/09/schemaorg-support-for-bibliographic_2.html).
References:
https://schema.org/Article
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
pageEnd: (Union[List[Union[str, int, Any]], str, int, Any]): The page on which the work ends; for example "138" or "xvi".
wordCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of words in the text of the Article.
articleSection: (Union[List[Union[str, Any]], str, Any]): Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc.
articleBody: (Union[List[Union[str, Any]], str, Any]): The actual body of the article.
speakable: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.The *speakable* property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:1.) *id-value* URL references - uses *id-value* of an element in the page being annotated. The simplest use of *speakable* has (potentially relative) URL values, referencing identified sections of the document concerned.2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property.For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the *speakable* property.
backstory: (Union[List[Union[str, Any]], str, Any]): For an [[Article]], typically a [[NewsArticle]], the backstory property provides a textual summary giving a brief explanation of why and how an article was created. In a journalistic setting this could include information about reporting process, methods, interviews, data sources, etc.
pagination: (Union[List[Union[str, Any]], str, Any]): Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49".
pageStart: (Union[List[Union[str, int, Any]], str, int, Any]): The page on which the work starts; for example "135" or "xiii".
"""
type_: str = Field(default="Article", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
pageEnd: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description='The page on which the work ends; for example "138" or "xvi".',
)
wordCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of words in the text of the Article.",
)
articleSection: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports,"
"Lifestyle, etc.",
)
articleBody: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The actual body of the article.",
)
speakable: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates sections of a Web page that are particularly 'speakable' in the sense of being"
"highlighted as being especially appropriate for text-to-speech conversion. Other"
"sections of a page may also be usefully spoken in particular circumstances; the 'speakable'"
"property serves to indicate the parts most likely to be generally useful for speech.The"
"*speakable* property can be repeated an arbitrary number of times, with three kinds"
"of possible 'content-locator' values:1.) *id-value* URL references - uses *id-value*"
"of an element in the page being annotated. The simplest use of *speakable* has (potentially"
"relative) URL values, referencing identified sections of the document concerned.2.)"
"CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use"
"the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming"
"an XML view of the content). Use the [[xpath]] property.For more sophisticated markup"
"of speakable sections beyond simple ID references, either CSS selectors or XPath expressions"
"to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]]"
"which is defined to be a possible value of the *speakable* property.",
)
backstory: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="For an [[Article]], typically a [[NewsArticle]], the backstory property provides"
"a textual summary giving a brief explanation of why and how an article was created. In"
"a journalistic setting this could include information about reporting process, methods,"
"interviews, data sources, etc.",
)
pagination: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Any description of pages that is not separated into pageStart and pageEnd; for example,"
'"1-6, 9, 55" or "10-12, 46-49".',
)
pageStart: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description='The page on which the work starts; for example "135" or "xiii".',
)
| 0.916918 | 0.374648 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SeatingMap(BaseModel):
"""A seating map.
References:
https://schema.org/SeatingMap
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="SeatingMap", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/SeatingMap.py
|
SeatingMap.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SeatingMap(BaseModel):
"""A seating map.
References:
https://schema.org/SeatingMap
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="SeatingMap", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.939011 | 0.31317 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SearchResultsPage(BaseModel):
"""Web page type: Search results page.
References:
https://schema.org/SearchResultsPage
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
significantLink: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): One of the more significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.
specialty: (Optional[Union[List[Union[str, Any]], str, Any]]): One of the domain specialities to which this web page's content applies.
reviewedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): People or organizations that have reviewed the content on this web page for accuracy and/or completeness.
lastReviewed: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Date on which the content on this web page was last reviewed for accuracy and/or completeness.
relatedLink: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link related to this web page, for example to other related web pages.
breadcrumb: (Union[List[Union[str, Any]], str, Any]): A set of links that can help a user understand and navigate a website hierarchy.
significantLinks: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The most significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.
mainContentOfPage: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates if this web page element is the main subject of the page.
speakable: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.The *speakable* property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:1.) *id-value* URL references - uses *id-value* of an element in the page being annotated. The simplest use of *speakable* has (potentially relative) URL values, referencing identified sections of the document concerned.2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property.For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the *speakable* property.
primaryImageOfPage: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the main image on the page.
"""
type_: str = Field(default="SearchResultsPage", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
significantLink: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="One of the more significant URLs on the page. Typically, these are the non-navigation"
"links that are clicked on the most.",
)
specialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One of the domain specialities to which this web page's content applies.",
)
reviewedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People or organizations that have reviewed the content on this web page for accuracy"
"and/or completeness.",
)
lastReviewed: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="Date on which the content on this web page was last reviewed for accuracy and/or completeness.",
)
relatedLink: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link related to this web page, for example to other related web pages.",
)
breadcrumb: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A set of links that can help a user understand and navigate a website hierarchy.",
)
significantLinks: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The most significant URLs on the page. Typically, these are the non-navigation links"
"that are clicked on the most.",
)
mainContentOfPage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates if this web page element is the main subject of the page.",
)
speakable: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates sections of a Web page that are particularly 'speakable' in the sense of being"
"highlighted as being especially appropriate for text-to-speech conversion. Other"
"sections of a page may also be usefully spoken in particular circumstances; the 'speakable'"
"property serves to indicate the parts most likely to be generally useful for speech.The"
"*speakable* property can be repeated an arbitrary number of times, with three kinds"
"of possible 'content-locator' values:1.) *id-value* URL references - uses *id-value*"
"of an element in the page being annotated. The simplest use of *speakable* has (potentially"
"relative) URL values, referencing identified sections of the document concerned.2.)"
"CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use"
"the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming"
"an XML view of the content). Use the [[xpath]] property.For more sophisticated markup"
"of speakable sections beyond simple ID references, either CSS selectors or XPath expressions"
"to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]]"
"which is defined to be a possible value of the *speakable* property.",
)
primaryImageOfPage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the main image on the page.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/SearchResultsPage.py
|
SearchResultsPage.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SearchResultsPage(BaseModel):
"""Web page type: Search results page.
References:
https://schema.org/SearchResultsPage
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
significantLink: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): One of the more significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.
specialty: (Optional[Union[List[Union[str, Any]], str, Any]]): One of the domain specialities to which this web page's content applies.
reviewedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): People or organizations that have reviewed the content on this web page for accuracy and/or completeness.
lastReviewed: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Date on which the content on this web page was last reviewed for accuracy and/or completeness.
relatedLink: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link related to this web page, for example to other related web pages.
breadcrumb: (Union[List[Union[str, Any]], str, Any]): A set of links that can help a user understand and navigate a website hierarchy.
significantLinks: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The most significant URLs on the page. Typically, these are the non-navigation links that are clicked on the most.
mainContentOfPage: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates if this web page element is the main subject of the page.
speakable: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in particular circumstances; the 'speakable' property serves to indicate the parts most likely to be generally useful for speech.The *speakable* property can be repeated an arbitrary number of times, with three kinds of possible 'content-locator' values:1.) *id-value* URL references - uses *id-value* of an element in the page being annotated. The simplest use of *speakable* has (potentially relative) URL values, referencing identified sections of the document concerned.2.) CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the [[xpath]] property.For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors or XPath expressions to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]] which is defined to be a possible value of the *speakable* property.
primaryImageOfPage: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the main image on the page.
"""
type_: str = Field(default="SearchResultsPage", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
significantLink: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="One of the more significant URLs on the page. Typically, these are the non-navigation"
"links that are clicked on the most.",
)
specialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One of the domain specialities to which this web page's content applies.",
)
reviewedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People or organizations that have reviewed the content on this web page for accuracy"
"and/or completeness.",
)
lastReviewed: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="Date on which the content on this web page was last reviewed for accuracy and/or completeness.",
)
relatedLink: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link related to this web page, for example to other related web pages.",
)
breadcrumb: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A set of links that can help a user understand and navigate a website hierarchy.",
)
significantLinks: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The most significant URLs on the page. Typically, these are the non-navigation links"
"that are clicked on the most.",
)
mainContentOfPage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates if this web page element is the main subject of the page.",
)
speakable: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates sections of a Web page that are particularly 'speakable' in the sense of being"
"highlighted as being especially appropriate for text-to-speech conversion. Other"
"sections of a page may also be usefully spoken in particular circumstances; the 'speakable'"
"property serves to indicate the parts most likely to be generally useful for speech.The"
"*speakable* property can be repeated an arbitrary number of times, with three kinds"
"of possible 'content-locator' values:1.) *id-value* URL references - uses *id-value*"
"of an element in the page being annotated. The simplest use of *speakable* has (potentially"
"relative) URL values, referencing identified sections of the document concerned.2.)"
"CSS Selectors - addresses content in the annotated page, e.g. via class attribute. Use"
"the [[cssSelector]] property.3.) XPaths - addresses content via XPaths (assuming"
"an XML view of the content). Use the [[xpath]] property.For more sophisticated markup"
"of speakable sections beyond simple ID references, either CSS selectors or XPath expressions"
"to pick out document section(s) as speakable. For thiswe define a supporting type, [[SpeakableSpecification]]"
"which is defined to be a possible value of the *speakable* property.",
)
primaryImageOfPage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the main image on the page.",
)
| 0.923747 | 0.316198 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class AggregateRating(BaseModel):
"""The average rating based on multiple ratings or reviews.
References:
https://schema.org/AggregateRating
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
reviewAspect: (Union[List[Union[str, Any]], str, Any]): This Review or Rating is relevant to this part or facet of the itemReviewed.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
ratingExplanation: (Union[List[Union[str, Any]], str, Any]): A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using [[ClaimReview]].
bestRating: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed.
ratingValue: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The rating for the content.Usage guidelines:* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
worstRating: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed.
itemReviewed: (Optional[Union[List[Union[str, Any]], str, Any]]): The item that is being reviewed/rated.
ratingCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The count of total number of ratings.
reviewCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The count of total number of reviews.
"""
type_: str = Field(default="AggregateRating", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
reviewAspect: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="This Review or Rating is relevant to this part or facet of the itemReviewed.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
ratingExplanation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A short explanation (e.g. one to two sentences) providing background context and other"
"information that led to the conclusion expressed in the rating. This is particularly"
'applicable to ratings associated with "fact check" markup using [[ClaimReview]].',
)
bestRating: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed.",
)
ratingValue: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The rating for the content.Usage guidelines:* Use values from 0123456789 (Unicode"
"'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar"
"Unicode symbols.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.",
)
worstRating: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed.",
)
itemReviewed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The item that is being reviewed/rated.",
)
ratingCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The count of total number of ratings.",
)
reviewCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The count of total number of reviews.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/AggregateRating.py
|
AggregateRating.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class AggregateRating(BaseModel):
"""The average rating based on multiple ratings or reviews.
References:
https://schema.org/AggregateRating
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
reviewAspect: (Union[List[Union[str, Any]], str, Any]): This Review or Rating is relevant to this part or facet of the itemReviewed.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
ratingExplanation: (Union[List[Union[str, Any]], str, Any]): A short explanation (e.g. one to two sentences) providing background context and other information that led to the conclusion expressed in the rating. This is particularly applicable to ratings associated with "fact check" markup using [[ClaimReview]].
bestRating: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed.
ratingValue: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The rating for the content.Usage guidelines:* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
worstRating: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed.
itemReviewed: (Optional[Union[List[Union[str, Any]], str, Any]]): The item that is being reviewed/rated.
ratingCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The count of total number of ratings.
reviewCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The count of total number of reviews.
"""
type_: str = Field(default="AggregateRating", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
reviewAspect: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="This Review or Rating is relevant to this part or facet of the itemReviewed.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
ratingExplanation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A short explanation (e.g. one to two sentences) providing background context and other"
"information that led to the conclusion expressed in the rating. This is particularly"
'applicable to ratings associated with "fact check" markup using [[ClaimReview]].',
)
bestRating: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed.",
)
ratingValue: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The rating for the content.Usage guidelines:* Use values from 0123456789 (Unicode"
"'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar"
"Unicode symbols.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.",
)
worstRating: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed.",
)
itemReviewed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The item that is being reviewed/rated.",
)
ratingCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The count of total number of ratings.",
)
reviewCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The count of total number of reviews.",
)
| 0.939408 | 0.411229 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ShippingRateSettings(BaseModel):
"""A ShippingRateSettings represents re-usable pieces of shipping information. 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 matched (i.e. identified/referenced) by their different values for [[shippingLabel]].
References:
https://schema.org/ShippingRateSettings
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
shippingDestination: (Optional[Union[List[Union[str, Any]], str, Any]]): indicates (possibly multiple) shipping destinations. These can be defined in several ways, e.g. postalCode ranges.
shippingLabel: (Union[List[Union[str, Any]], str, Any]): Label to match an [[OfferShippingDetails]] with a [[ShippingRateSettings]] (within the context of a [[shippingSettingsLink]] cross-reference).
doesNotShip: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates when shipping to a particular [[shippingDestination]] is not available.
freeShippingThreshold: (Optional[Union[List[Union[str, Any]], str, Any]]): A monetary value above (or at) which the shipping rate becomes free. Intended to be used via an [[OfferShippingDetails]] with [[shippingSettingsLink]] matching this [[ShippingRateSettings]].
shippingRate: (Optional[Union[List[Union[str, Any]], str, Any]]): The shipping rate is the cost of shipping to the specified destination. Typically, the maxValue and currency values (of the [[MonetaryAmount]]) are most appropriate.
isUnlabelledFallback: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): This can be marked 'true' to indicate that some published [[DeliveryTimeSettings]] or [[ShippingRateSettings]] are intended to apply to all [[OfferShippingDetails]] published by the same merchant, when referenced by a [[shippingSettingsLink]] in those settings. It is not meaningful to use a 'true' value for this property alongside a transitTimeLabel (for [[DeliveryTimeSettings]]) or shippingLabel (for [[ShippingRateSettings]]), since this property is for use with unlabelled settings.
"""
type_: str = Field(default="ShippingRateSettings", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
shippingDestination: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="indicates (possibly multiple) shipping destinations. These can be defined in several"
"ways, e.g. postalCode ranges.",
)
shippingLabel: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Label to match an [[OfferShippingDetails]] with a [[ShippingRateSettings]] (within"
"the context of a [[shippingSettingsLink]] cross-reference).",
)
doesNotShip: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates when shipping to a particular [[shippingDestination]] is not available.",
)
freeShippingThreshold: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A monetary value above (or at) which the shipping rate becomes free. Intended to be used"
"via an [[OfferShippingDetails]] with [[shippingSettingsLink]] matching this [[ShippingRateSettings]].",
)
shippingRate: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The shipping rate is the cost of shipping to the specified destination. Typically, the"
"maxValue and currency values (of the [[MonetaryAmount]]) are most appropriate.",
)
isUnlabelledFallback: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="This can be marked 'true' to indicate that some published [[DeliveryTimeSettings]]"
"or [[ShippingRateSettings]] are intended to apply to all [[OfferShippingDetails]]"
"published by the same merchant, when referenced by a [[shippingSettingsLink]] in those"
"settings. It is not meaningful to use a 'true' value for this property alongside a transitTimeLabel"
"(for [[DeliveryTimeSettings]]) or shippingLabel (for [[ShippingRateSettings]]),"
"since this property is for use with unlabelled settings.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/ShippingRateSettings.py
|
ShippingRateSettings.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ShippingRateSettings(BaseModel):
"""A ShippingRateSettings represents re-usable pieces of shipping information. 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 matched (i.e. identified/referenced) by their different values for [[shippingLabel]].
References:
https://schema.org/ShippingRateSettings
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
shippingDestination: (Optional[Union[List[Union[str, Any]], str, Any]]): indicates (possibly multiple) shipping destinations. These can be defined in several ways, e.g. postalCode ranges.
shippingLabel: (Union[List[Union[str, Any]], str, Any]): Label to match an [[OfferShippingDetails]] with a [[ShippingRateSettings]] (within the context of a [[shippingSettingsLink]] cross-reference).
doesNotShip: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates when shipping to a particular [[shippingDestination]] is not available.
freeShippingThreshold: (Optional[Union[List[Union[str, Any]], str, Any]]): A monetary value above (or at) which the shipping rate becomes free. Intended to be used via an [[OfferShippingDetails]] with [[shippingSettingsLink]] matching this [[ShippingRateSettings]].
shippingRate: (Optional[Union[List[Union[str, Any]], str, Any]]): The shipping rate is the cost of shipping to the specified destination. Typically, the maxValue and currency values (of the [[MonetaryAmount]]) are most appropriate.
isUnlabelledFallback: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): This can be marked 'true' to indicate that some published [[DeliveryTimeSettings]] or [[ShippingRateSettings]] are intended to apply to all [[OfferShippingDetails]] published by the same merchant, when referenced by a [[shippingSettingsLink]] in those settings. It is not meaningful to use a 'true' value for this property alongside a transitTimeLabel (for [[DeliveryTimeSettings]]) or shippingLabel (for [[ShippingRateSettings]]), since this property is for use with unlabelled settings.
"""
type_: str = Field(default="ShippingRateSettings", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
shippingDestination: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="indicates (possibly multiple) shipping destinations. These can be defined in several"
"ways, e.g. postalCode ranges.",
)
shippingLabel: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Label to match an [[OfferShippingDetails]] with a [[ShippingRateSettings]] (within"
"the context of a [[shippingSettingsLink]] cross-reference).",
)
doesNotShip: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates when shipping to a particular [[shippingDestination]] is not available.",
)
freeShippingThreshold: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A monetary value above (or at) which the shipping rate becomes free. Intended to be used"
"via an [[OfferShippingDetails]] with [[shippingSettingsLink]] matching this [[ShippingRateSettings]].",
)
shippingRate: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The shipping rate is the cost of shipping to the specified destination. Typically, the"
"maxValue and currency values (of the [[MonetaryAmount]]) are most appropriate.",
)
isUnlabelledFallback: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="This can be marked 'true' to indicate that some published [[DeliveryTimeSettings]]"
"or [[ShippingRateSettings]] are intended to apply to all [[OfferShippingDetails]]"
"published by the same merchant, when referenced by a [[shippingSettingsLink]] in those"
"settings. It is not meaningful to use a 'true' value for this property alongside a transitTimeLabel"
"(for [[DeliveryTimeSettings]]) or shippingLabel (for [[ShippingRateSettings]]),"
"since this property is for use with unlabelled settings.",
)
| 0.94119 | 0.323794 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DeliveryMethod(BaseModel):
"""A delivery method is a standardized procedure for transferring the product or service to the destination of fulfillment chosen by the customer. Delivery methods are characterized by the means of transportation used, and by the organization or group that is the contracting party for the sending organization or person.Commonly used values:* http://purl.org/goodrelations/v1#DeliveryModeDirectDownload* http://purl.org/goodrelations/v1#DeliveryModeFreight* http://purl.org/goodrelations/v1#DeliveryModeMail* http://purl.org/goodrelations/v1#DeliveryModeOwnFleet* http://purl.org/goodrelations/v1#DeliveryModePickUp* http://purl.org/goodrelations/v1#DHL* http://purl.org/goodrelations/v1#FederalExpress* http://purl.org/goodrelations/v1#UPS
References:
https://schema.org/DeliveryMethod
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="DeliveryMethod", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/DeliveryMethod.py
|
DeliveryMethod.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DeliveryMethod(BaseModel):
"""A delivery method is a standardized procedure for transferring the product or service to the destination of fulfillment chosen by the customer. Delivery methods are characterized by the means of transportation used, and by the organization or group that is the contracting party for the sending organization or person.Commonly used values:* http://purl.org/goodrelations/v1#DeliveryModeDirectDownload* http://purl.org/goodrelations/v1#DeliveryModeFreight* http://purl.org/goodrelations/v1#DeliveryModeMail* http://purl.org/goodrelations/v1#DeliveryModeOwnFleet* http://purl.org/goodrelations/v1#DeliveryModePickUp* http://purl.org/goodrelations/v1#DHL* http://purl.org/goodrelations/v1#FederalExpress* http://purl.org/goodrelations/v1#UPS
References:
https://schema.org/DeliveryMethod
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="DeliveryMethod", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.936416 | 0.279794 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Project(BaseModel):
"""An enterprise (potentially individual but typically collaborative), planned to achieve a particular aim.Use properties from [[Organization]], [[subOrganization]]/[[parentOrganization]] to indicate project sub-structures.
References:
https://schema.org/Project
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
"""
type_: str = Field(default="Project", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Project.py
|
Project.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Project(BaseModel):
"""An enterprise (potentially individual but typically collaborative), planned to achieve a particular aim.Use properties from [[Organization]], [[subOrganization]]/[[parentOrganization]] to indicate project sub-structures.
References:
https://schema.org/Project
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
"""
type_: str = Field(default="Project", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
| 0.88306 | 0.384999 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OnSitePickup(BaseModel):
"""A DeliveryMethod in which an item is collected on site, e.g. in a store or at a box office.
References:
https://schema.org/OnSitePickup
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="OnSitePickup", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/OnSitePickup.py
|
OnSitePickup.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OnSitePickup(BaseModel):
"""A DeliveryMethod in which an item is collected on site, e.g. in a store or at a box office.
References:
https://schema.org/OnSitePickup
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="OnSitePickup", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.946001 | 0.305736 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MediaObject(BaseModel):
"""A media object, such as an image, video, or audio object embedded in a web page or a downloadable dataset, i.e. DataDownload. Note that a creative work may have many media objects associated with it on the same web page. For example, a page about a single song (MusicRecording) may have a music video (VideoObject), and a high and low bandwidth audio stream (2 [[AudioObject]]s).
References:
https://schema.org/MediaObject
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
embedUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL pointing to a player for a specific video. In general, this is the information in the ```src``` element of an ```embed``` tag and should not be the same as the content of the ```loc``` tag.
bitrate: (Union[List[Union[str, Any]], str, Any]): The bitrate of the media object.
width: (Optional[Union[List[Union[str, Any]], str, Any]]): The width of the item.
sha256: (Union[List[Union[str, Any]], str, Any]): The [SHA-2](https://en.wikipedia.org/wiki/SHA-2) SHA256 hash of the content of the item. For example, a zero-length input has value 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
contentSize: (Union[List[Union[str, Any]], str, Any]): File size in (mega/kilo)bytes.
height: (Optional[Union[List[Union[str, Any]], str, Any]]): The height of the item.
playerType: (Union[List[Union[str, Any]], str, Any]): Player type required—for example, Flash or Silverlight.
associatedArticle: (Optional[Union[List[Union[str, Any]], str, Any]]): A NewsArticle associated with the Media Object.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
requiresSubscription: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates if use of the media require a subscription (either paid or free). Allowed values are ```true``` or ```false``` (note that an earlier version had 'yes', 'no').
regionsAllowed: (Optional[Union[List[Union[str, Any]], str, Any]]): The regions where the media is allowed. If not specified, then it's assumed to be allowed everywhere. Specify the countries in [ISO 3166 format](http://en.wikipedia.org/wiki/ISO_3166).
contentUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Actual bytes of the media object, for example the image file or video file.
productionCompany: (Optional[Union[List[Union[str, Any]], str, Any]]): The production company or studio responsible for the item, e.g. series, video game, episode etc.
encodesCreativeWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The CreativeWork encoded by this media object.
uploadDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Date when this media object was uploaded to this site.
ineligibleRegion: (Union[List[Union[str, Any]], str, Any]): The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.See also [[eligibleRegion]].
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
"""
type_: str = Field(default="MediaObject", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
embedUrl: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL pointing to a player for a specific video. In general, this is the information in"
"the ```src``` element of an ```embed``` tag and should not be the same as the content of"
"the ```loc``` tag.",
)
bitrate: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The bitrate of the media object.",
)
width: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The width of the item.",
)
sha256: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [SHA-2](https://en.wikipedia.org/wiki/SHA-2) SHA256 hash of the content of"
"the item. For example, a zero-length input has value 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
contentSize: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="File size in (mega/kilo)bytes.",
)
height: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The height of the item.",
)
playerType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Player type required—for example, Flash or Silverlight.",
)
associatedArticle: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A NewsArticle associated with the Media Object.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
requiresSubscription: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates if use of the media require a subscription (either paid or free). Allowed values"
"are ```true``` or ```false``` (note that an earlier version had 'yes', 'no').",
)
regionsAllowed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The regions where the media is allowed. If not specified, then it's assumed to be allowed"
"everywhere. Specify the countries in [ISO 3166 format](http://en.wikipedia.org/wiki/ISO_3166).",
)
contentUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Actual bytes of the media object, for example the image file or video file.",
)
productionCompany: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The production company or studio responsible for the item, e.g. series, video game,"
"episode etc.",
)
encodesCreativeWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The CreativeWork encoded by this media object.",
)
uploadDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="Date when this media object was uploaded to this site.",
)
ineligibleRegion: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for"
"the geo-political region(s) for which the offer or delivery charge specification is"
"not valid, e.g. a region where the transaction is not allowed.See also [[eligibleRegion]].",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MediaObject.py
|
MediaObject.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MediaObject(BaseModel):
"""A media object, such as an image, video, or audio object embedded in a web page or a downloadable dataset, i.e. DataDownload. Note that a creative work may have many media objects associated with it on the same web page. For example, a page about a single song (MusicRecording) may have a music video (VideoObject), and a high and low bandwidth audio stream (2 [[AudioObject]]s).
References:
https://schema.org/MediaObject
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
embedUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL pointing to a player for a specific video. In general, this is the information in the ```src``` element of an ```embed``` tag and should not be the same as the content of the ```loc``` tag.
bitrate: (Union[List[Union[str, Any]], str, Any]): The bitrate of the media object.
width: (Optional[Union[List[Union[str, Any]], str, Any]]): The width of the item.
sha256: (Union[List[Union[str, Any]], str, Any]): The [SHA-2](https://en.wikipedia.org/wiki/SHA-2) SHA256 hash of the content of the item. For example, a zero-length input has value 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
contentSize: (Union[List[Union[str, Any]], str, Any]): File size in (mega/kilo)bytes.
height: (Optional[Union[List[Union[str, Any]], str, Any]]): The height of the item.
playerType: (Union[List[Union[str, Any]], str, Any]): Player type required—for example, Flash or Silverlight.
associatedArticle: (Optional[Union[List[Union[str, Any]], str, Any]]): A NewsArticle associated with the Media Object.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
requiresSubscription: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates if use of the media require a subscription (either paid or free). Allowed values are ```true``` or ```false``` (note that an earlier version had 'yes', 'no').
regionsAllowed: (Optional[Union[List[Union[str, Any]], str, Any]]): The regions where the media is allowed. If not specified, then it's assumed to be allowed everywhere. Specify the countries in [ISO 3166 format](http://en.wikipedia.org/wiki/ISO_3166).
contentUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Actual bytes of the media object, for example the image file or video file.
productionCompany: (Optional[Union[List[Union[str, Any]], str, Any]]): The production company or studio responsible for the item, e.g. series, video game, episode etc.
encodesCreativeWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The CreativeWork encoded by this media object.
uploadDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Date when this media object was uploaded to this site.
ineligibleRegion: (Union[List[Union[str, Any]], str, Any]): The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.See also [[eligibleRegion]].
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
"""
type_: str = Field(default="MediaObject", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
embedUrl: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL pointing to a player for a specific video. In general, this is the information in"
"the ```src``` element of an ```embed``` tag and should not be the same as the content of"
"the ```loc``` tag.",
)
bitrate: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The bitrate of the media object.",
)
width: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The width of the item.",
)
sha256: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [SHA-2](https://en.wikipedia.org/wiki/SHA-2) SHA256 hash of the content of"
"the item. For example, a zero-length input has value 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
contentSize: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="File size in (mega/kilo)bytes.",
)
height: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The height of the item.",
)
playerType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Player type required—for example, Flash or Silverlight.",
)
associatedArticle: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A NewsArticle associated with the Media Object.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
requiresSubscription: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates if use of the media require a subscription (either paid or free). Allowed values"
"are ```true``` or ```false``` (note that an earlier version had 'yes', 'no').",
)
regionsAllowed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The regions where the media is allowed. If not specified, then it's assumed to be allowed"
"everywhere. Specify the countries in [ISO 3166 format](http://en.wikipedia.org/wiki/ISO_3166).",
)
contentUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Actual bytes of the media object, for example the image file or video file.",
)
productionCompany: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The production company or studio responsible for the item, e.g. series, video game,"
"episode etc.",
)
encodesCreativeWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The CreativeWork encoded by this media object.",
)
uploadDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="Date when this media object was uploaded to this site.",
)
ineligibleRegion: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for"
"the geo-political region(s) for which the offer or delivery charge specification is"
"not valid, e.g. a region where the transaction is not allowed.See also [[eligibleRegion]].",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
| 0.9237 | 0.370112 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c13(BaseModel):
"""Nonprofit501c13: Non-profit type referring to Cemetery Companies.
References:
https://schema.org/Nonprofit501c13
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Nonprofit501c13", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Nonprofit501c13.py
|
Nonprofit501c13.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c13(BaseModel):
"""Nonprofit501c13: Non-profit type referring to Cemetery Companies.
References:
https://schema.org/Nonprofit501c13
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Nonprofit501c13", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.94474 | 0.256925 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Consortium(BaseModel):
"""A Consortium is a membership [[Organization]] whose members are typically Organizations.
References:
https://schema.org/Consortium
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
"""
type_: str = Field(default="Consortium", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Consortium.py
|
Consortium.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Consortium(BaseModel):
"""A Consortium is a membership [[Organization]] whose members are typically Organizations.
References:
https://schema.org/Consortium
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
"""
type_: str = Field(default="Consortium", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
| 0.897585 | 0.38604 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CourseInstance(BaseModel):
"""An instance of a [[Course]] which is distinct from other instances because it is offered at a different time or location or through different media or modes of study or to a specific section of students.
References:
https://schema.org/CourseInstance
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
performer: (Optional[Union[List[Union[str, Any]], str, Any]]): A performer at the event—for example, a presenter, musician, musical group or actor.
eventAttendanceMode: (Optional[Union[List[Union[str, Any]], str, Any]]): The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix.
workFeatured: (Optional[Union[List[Union[str, Any]], str, Any]]): A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).
remainingAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of attendee places for an event that remain unallocated.
actor: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.
doorTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The time admission will commence.
previousStartDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Used in conjunction with eventStatus for rescheduled or cancelled events. This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated.
recordedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The CreativeWork that captured all or part of this Event.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
superEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An event that this event is a part of. For example, a collection of individual music performances might each have a music festival as their superEvent.
eventSchedule: (Optional[Union[List[Union[str, Any]], str, Any]]): Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An [[Event]] that is associated with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]] properties. These are instead defined within the associated [[Schedule]], this avoids any ambiguity for clients using the data. The property might have repeated values to specify different schedules, e.g. for different months or seasons.
maximumVirtualAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).
attendees: (Optional[Union[List[Union[str, Any]], str, Any]]): A person attending the event.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
eventStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
workPerformed: (Optional[Union[List[Union[str, Any]], str, Any]]): A work performed in some event, for example a play performed in a TheaterEvent.
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
composer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who wrote a composition, or who is the composer of a work performed at some event.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
subEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
attendee: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization attending the event.
subEvents: (Optional[Union[List[Union[str, Any]], str, Any]]): Events that are a part of this event. For example, a conference event includes many presentations, each subEvents of the conference.
performers: (Optional[Union[List[Union[str, Any]], str, Any]]): The main performer or performers of the event—for example, a presenter, musician, or actor.
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
maximumPhysicalAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).
director: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
startDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
endDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
organizer: (Optional[Union[List[Union[str, Any]], str, Any]]): An organizer of an Event.
courseWorkload: (Union[List[Union[str, Any]], str, Any]): The amount of work expected of students taking the course, often provided as a figure per week or per month, and may be broken down by type. For example, "2 hours of lectures, 1 hour of lab work and 3 hours of independent study per week".
courseMode: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The medium or means of delivery of the course instance or the mode of study, either as a text label (e.g. "online", "onsite" or "blended"; "synchronous" or "asynchronous"; "full-time" or "part-time") or as a URL reference to a term from a controlled vocabulary (e.g. https://ceds.ed.gov/element/001311#Asynchronous).
instructor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person assigned to instruct or provide instructional assistance for the [[CourseInstance]].
"""
type_: str = Field(default="CourseInstance", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
performer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A performer at the event—for example, a presenter, musician, musical group"
"or actor.",
)
eventAttendanceMode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The eventAttendanceMode of an event indicates whether it occurs online, offline, or"
"a mix.",
)
workFeatured: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties"
"are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).",
)
remainingAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The number of attendee places for an event that remain unallocated.",
)
actor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated"
"with individual items or with a series, episode, clip.",
)
doorTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The time admission will commence.",
)
previousStartDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Used in conjunction with eventStatus for rescheduled or cancelled events. This property"
"contains the previously scheduled start date. For rescheduled events, the startDate"
"property should be used for the newly scheduled start date. In the (rare) case of an event"
"that has been postponed and rescheduled multiple times, this field may be repeated.",
)
recordedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The CreativeWork that captured all or part of this Event.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
superEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An event that this event is a part of. For example, a collection of individual music performances"
"might each have a music festival as their superEvent.",
)
eventSchedule: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable"
"to share a schedule for a series of repeating events rather than data on the individual"
"events themselves. For example, a website or application might prefer to publish a schedule"
"for a weekly gym class rather than provide data on every event. A schedule could be processed"
"by applications to add forthcoming events to a calendar. An [[Event]] that is associated"
"with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]]"
"properties. These are instead defined within the associated [[Schedule]], this avoids"
"any ambiguity for clients using the data. The property might have repeated values to"
"specify different schedules, e.g. for different months or seasons.",
)
maximumVirtualAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
attendees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person attending the event.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
eventStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An eventStatus of an event represents its status; particularly useful when an event"
"is cancelled or rescheduled.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
workPerformed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work performed in some event, for example a play performed in a TheaterEvent.",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
composer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who wrote a composition, or who is the composer of a work performed"
"at some event.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
subEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Event that is part of this event. For example, a conference event includes many presentations,"
"each of which is a subEvent of the conference.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
attendee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization attending the event.",
)
subEvents: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Events that are a part of this event. For example, a conference event includes many presentations,"
"each subEvents of the conference.",
)
performers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The main performer or performers of the event—for example, a presenter, musician,"
"or actor.",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
maximumPhysicalAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
director: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors"
"can be associated with individual items or with a series, episode, clip.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
startDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
endDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
organizer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An organizer of an Event.",
)
courseWorkload: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The amount of work expected of students taking the course, often provided as a figure"
'per week or per month, and may be broken down by type. For example, "2 hours of lectures,'
'1 hour of lab work and 3 hours of independent study per week".',
)
courseMode: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The medium or means of delivery of the course instance or the mode of study, either as a"
'text label (e.g. "online", "onsite" or "blended"; "synchronous" or "asynchronous";'
'"full-time" or "part-time") or as a URL reference to a term from a controlled vocabulary'
"(e.g. https://ceds.ed.gov/element/001311#Asynchronous).",
)
instructor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person assigned to instruct or provide instructional assistance for the [[CourseInstance]].",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/CourseInstance.py
|
CourseInstance.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CourseInstance(BaseModel):
"""An instance of a [[Course]] which is distinct from other instances because it is offered at a different time or location or through different media or modes of study or to a specific section of students.
References:
https://schema.org/CourseInstance
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
performer: (Optional[Union[List[Union[str, Any]], str, Any]]): A performer at the event—for example, a presenter, musician, musical group or actor.
eventAttendanceMode: (Optional[Union[List[Union[str, Any]], str, Any]]): The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix.
workFeatured: (Optional[Union[List[Union[str, Any]], str, Any]]): A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).
remainingAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of attendee places for an event that remain unallocated.
actor: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.
doorTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The time admission will commence.
previousStartDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Used in conjunction with eventStatus for rescheduled or cancelled events. This property contains the previously scheduled start date. For rescheduled events, the startDate property should be used for the newly scheduled start date. In the (rare) case of an event that has been postponed and rescheduled multiple times, this field may be repeated.
recordedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The CreativeWork that captured all or part of this Event.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
superEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An event that this event is a part of. For example, a collection of individual music performances might each have a music festival as their superEvent.
eventSchedule: (Optional[Union[List[Union[str, Any]], str, Any]]): Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An [[Event]] that is associated with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]] properties. These are instead defined within the associated [[Schedule]], this avoids any ambiguity for clients using the data. The property might have repeated values to specify different schedules, e.g. for different months or seasons.
maximumVirtualAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).
attendees: (Optional[Union[List[Union[str, Any]], str, Any]]): A person attending the event.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
eventStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): An eventStatus of an event represents its status; particularly useful when an event is cancelled or rescheduled.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
workPerformed: (Optional[Union[List[Union[str, Any]], str, Any]]): A work performed in some event, for example a play performed in a TheaterEvent.
duration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
composer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who wrote a composition, or who is the composer of a work performed at some event.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
subEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): An Event that is part of this event. For example, a conference event includes many presentations, each of which is a subEvent of the conference.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
attendee: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization attending the event.
subEvents: (Optional[Union[List[Union[str, Any]], str, Any]]): Events that are a part of this event. For example, a conference event includes many presentations, each subEvents of the conference.
performers: (Optional[Union[List[Union[str, Any]], str, Any]]): The main performer or performers of the event—for example, a presenter, musician, or actor.
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
maximumPhysicalAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]] is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).
director: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
startDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
endDate: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
organizer: (Optional[Union[List[Union[str, Any]], str, Any]]): An organizer of an Event.
courseWorkload: (Union[List[Union[str, Any]], str, Any]): The amount of work expected of students taking the course, often provided as a figure per week or per month, and may be broken down by type. For example, "2 hours of lectures, 1 hour of lab work and 3 hours of independent study per week".
courseMode: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The medium or means of delivery of the course instance or the mode of study, either as a text label (e.g. "online", "onsite" or "blended"; "synchronous" or "asynchronous"; "full-time" or "part-time") or as a URL reference to a term from a controlled vocabulary (e.g. https://ceds.ed.gov/element/001311#Asynchronous).
instructor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person assigned to instruct or provide instructional assistance for the [[CourseInstance]].
"""
type_: str = Field(default="CourseInstance", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
performer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A performer at the event—for example, a presenter, musician, musical group"
"or actor.",
)
eventAttendanceMode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The eventAttendanceMode of an event indicates whether it occurs online, offline, or"
"a mix.",
)
workFeatured: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work featured in some event, e.g. exhibited in an ExhibitionEvent. Specific subproperties"
"are available for workPerformed (e.g. a play), or a workPresented (a Movie at a ScreeningEvent).",
)
remainingAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The number of attendee places for an event that remain unallocated.",
)
actor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated"
"with individual items or with a series, episode, clip.",
)
doorTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The time admission will commence.",
)
previousStartDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Used in conjunction with eventStatus for rescheduled or cancelled events. This property"
"contains the previously scheduled start date. For rescheduled events, the startDate"
"property should be used for the newly scheduled start date. In the (rare) case of an event"
"that has been postponed and rescheduled multiple times, this field may be repeated.",
)
recordedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The CreativeWork that captured all or part of this Event.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
superEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An event that this event is a part of. For example, a collection of individual music performances"
"might each have a music festival as their superEvent.",
)
eventSchedule: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Associates an [[Event]] with a [[Schedule]]. There are circumstances where it is preferable"
"to share a schedule for a series of repeating events rather than data on the individual"
"events themselves. For example, a website or application might prefer to publish a schedule"
"for a weekly gym class rather than provide data on every event. A schedule could be processed"
"by applications to add forthcoming events to a calendar. An [[Event]] that is associated"
"with a [[Schedule]] using this property should not have [[startDate]] or [[endDate]]"
"properties. These are instead defined within the associated [[Schedule]], this avoids"
"any ambiguity for clients using the data. The property might have repeated values to"
"specify different schedules, e.g. for different months or seasons.",
)
maximumVirtualAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OnlineEventAttendanceMode]] (or the online aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
attendees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person attending the event.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
eventStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An eventStatus of an event represents its status; particularly useful when an event"
"is cancelled or rescheduled.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
workPerformed: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work performed in some event, for example a play performed in a TheaterEvent.",
)
duration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
composer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who wrote a composition, or who is the composer of a work performed"
"at some event.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
subEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Event that is part of this event. For example, a conference event includes many presentations,"
"each of which is a subEvent of the conference.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
attendee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization attending the event.",
)
subEvents: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Events that are a part of this event. For example, a conference event includes many presentations,"
"each subEvents of the conference.",
)
performers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The main performer or performers of the event—for example, a presenter, musician,"
"or actor.",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
maximumPhysicalAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The maximum physical attendee capacity of an [[Event]] whose [[eventAttendanceMode]]"
"is [[OfflineEventAttendanceMode]] (or the offline aspects, in the case of a [[MixedEventAttendanceMode]]).",
)
director: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors"
"can be associated with individual items or with a series, episode, clip.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
startDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
endDate: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
organizer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An organizer of an Event.",
)
courseWorkload: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The amount of work expected of students taking the course, often provided as a figure"
'per week or per month, and may be broken down by type. For example, "2 hours of lectures,'
'1 hour of lab work and 3 hours of independent study per week".',
)
courseMode: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The medium or means of delivery of the course instance or the mode of study, either as a"
'text label (e.g. "online", "onsite" or "blended"; "synchronous" or "asynchronous";'
'"full-time" or "part-time") or as a URL reference to a term from a controlled vocabulary'
"(e.g. https://ceds.ed.gov/element/001311#Asynchronous).",
)
instructor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person assigned to instruct or provide instructional assistance for the [[CourseInstance]].",
)
| 0.922952 | 0.374019 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class True_(BaseModel):
"""The boolean value true.
References:
https://schema.org/True
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="True", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/True_.py
|
True_.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class True_(BaseModel):
"""The boolean value true.
References:
https://schema.org/True
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="True", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.936851 | 0.319758 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BasicIncome(BaseModel):
"""BasicIncome: this is a benefit for basic income.
References:
https://schema.org/BasicIncome
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="BasicIncome", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/BasicIncome.py
|
BasicIncome.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BasicIncome(BaseModel):
"""BasicIncome: this is a benefit for basic income.
References:
https://schema.org/BasicIncome
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="BasicIncome", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.944868 | 0.347814 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EducationalOrganization(BaseModel):
"""An educational organization.
References:
https://schema.org/EducationalOrganization
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
"""
type_: str = Field(default="EducationalOrganization", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/EducationalOrganization.py
|
EducationalOrganization.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EducationalOrganization(BaseModel):
"""An educational organization.
References:
https://schema.org/EducationalOrganization
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
"""
type_: str = Field(default="EducationalOrganization", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
| 0.946275 | 0.511961 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DiagnosticProcedure(BaseModel):
"""A medical procedure intended primarily for diagnostic, as opposed to therapeutic, purposes.
References:
https://schema.org/DiagnosticProcedure
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
recognizingAuthority: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.
relevantSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, a medical specialty in which this entity is relevant.
medicineSystem: (Optional[Union[List[Union[str, Any]], str, Any]]): The system of medicine that includes this MedicalEntity, for example 'evidence-based', 'homeopathic', 'chiropractic', etc.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
legalStatus: (Union[List[Union[str, Any]], str, Any]): The drug or supplement's legal status, including any controlled substance schedules that apply.
study: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical study or trial related to this entity.
guideline: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical guideline related to this entity.
code: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
howPerformed: (Union[List[Union[str, Any]], str, Any]): How the procedure is performed.
procedureType: (Optional[Union[List[Union[str, Any]], str, Any]]): The type of procedure, for example Surgical, Noninvasive, or Percutaneous.
status: (Union[List[Union[str, Any]], str, Any]): The status of the study (enumerated).
bodyLocation: (Union[List[Union[str, Any]], str, Any]): Location in the body of the anatomical structure.
followup: (Union[List[Union[str, Any]], str, Any]): Typical or recommended followup care after the procedure is performed.
preparation: (Union[List[Union[str, Any]], str, Any]): Typical preparation that a patient must undergo before having the procedure performed.
"""
type_: str = Field(default="DiagnosticProcedure", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
recognizingAuthority: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, the organization that officially recognizes this entity as part of its"
"endorsed system of medicine.",
)
relevantSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, a medical specialty in which this entity is relevant.",
)
medicineSystem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The system of medicine that includes this MedicalEntity, for example 'evidence-based',"
"'homeopathic', 'chiropractic', etc.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
legalStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The drug or supplement's legal status, including any controlled substance schedules"
"that apply.",
)
study: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical study or trial related to this entity.",
)
guideline: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical guideline related to this entity.",
)
code: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical code for the entity, taken from a controlled vocabulary or ontology such as"
"ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.",
)
howPerformed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="How the procedure is performed.",
)
procedureType: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The type of procedure, for example Surgical, Noninvasive, or Percutaneous.",
)
status: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of the study (enumerated).",
)
bodyLocation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Location in the body of the anatomical structure.",
)
followup: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Typical or recommended followup care after the procedure is performed.",
)
preparation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Typical preparation that a patient must undergo before having the procedure performed.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/DiagnosticProcedure.py
|
DiagnosticProcedure.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DiagnosticProcedure(BaseModel):
"""A medical procedure intended primarily for diagnostic, as opposed to therapeutic, purposes.
References:
https://schema.org/DiagnosticProcedure
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
recognizingAuthority: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, the organization that officially recognizes this entity as part of its endorsed system of medicine.
relevantSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): If applicable, a medical specialty in which this entity is relevant.
medicineSystem: (Optional[Union[List[Union[str, Any]], str, Any]]): The system of medicine that includes this MedicalEntity, for example 'evidence-based', 'homeopathic', 'chiropractic', etc.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
legalStatus: (Union[List[Union[str, Any]], str, Any]): The drug or supplement's legal status, including any controlled substance schedules that apply.
study: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical study or trial related to this entity.
guideline: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical guideline related to this entity.
code: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical code for the entity, taken from a controlled vocabulary or ontology such as ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.
howPerformed: (Union[List[Union[str, Any]], str, Any]): How the procedure is performed.
procedureType: (Optional[Union[List[Union[str, Any]], str, Any]]): The type of procedure, for example Surgical, Noninvasive, or Percutaneous.
status: (Union[List[Union[str, Any]], str, Any]): The status of the study (enumerated).
bodyLocation: (Union[List[Union[str, Any]], str, Any]): Location in the body of the anatomical structure.
followup: (Union[List[Union[str, Any]], str, Any]): Typical or recommended followup care after the procedure is performed.
preparation: (Union[List[Union[str, Any]], str, Any]): Typical preparation that a patient must undergo before having the procedure performed.
"""
type_: str = Field(default="DiagnosticProcedure", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
recognizingAuthority: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, the organization that officially recognizes this entity as part of its"
"endorsed system of medicine.",
)
relevantSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="If applicable, a medical specialty in which this entity is relevant.",
)
medicineSystem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The system of medicine that includes this MedicalEntity, for example 'evidence-based',"
"'homeopathic', 'chiropractic', etc.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
legalStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The drug or supplement's legal status, including any controlled substance schedules"
"that apply.",
)
study: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical study or trial related to this entity.",
)
guideline: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical guideline related to this entity.",
)
code: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical code for the entity, taken from a controlled vocabulary or ontology such as"
"ICD-9, DiseasesDB, MeSH, SNOMED-CT, RxNorm, etc.",
)
howPerformed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="How the procedure is performed.",
)
procedureType: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The type of procedure, for example Surgical, Noninvasive, or Percutaneous.",
)
status: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of the study (enumerated).",
)
bodyLocation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Location in the body of the anatomical structure.",
)
followup: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Typical or recommended followup care after the procedure is performed.",
)
preparation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Typical preparation that a patient must undergo before having the procedure performed.",
)
| 0.931412 | 0.308346 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableSizeGroupMisses(BaseModel):
"""Size group "Misses" (also known as "Missy") for wearables.
References:
https://schema.org/WearableSizeGroupMisses
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="WearableSizeGroupMisses", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/WearableSizeGroupMisses.py
|
WearableSizeGroupMisses.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableSizeGroupMisses(BaseModel):
"""Size group "Misses" (also known as "Missy") for wearables.
References:
https://schema.org/WearableSizeGroupMisses
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="WearableSizeGroupMisses", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.940456 | 0.303906 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DayOfWeek(BaseModel):
"""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.
References:
https://schema.org/DayOfWeek
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="DayOfWeek", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/DayOfWeek.py
|
DayOfWeek.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DayOfWeek(BaseModel):
"""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.
References:
https://schema.org/DayOfWeek
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="DayOfWeek", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.940161 | 0.389663 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TransferAction(BaseModel):
"""The act of transferring/moving (abstract or concrete) animate or inanimate objects from one place to another.
References:
https://schema.org/TransferAction
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
result: (Optional[Union[List[Union[str, Any]], str, Any]]): The result produced in the action. E.g. John wrote *a book*.
actionStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the current disposition of the Action.
agent: (Optional[Union[List[Union[str, Any]], str, Any]]): The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.
instrument: (Optional[Union[List[Union[str, Any]], str, Any]]): The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.
object: (Optional[Union[List[Union[str, Any]], str, Any]]): The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read *a book*.
error: (Optional[Union[List[Union[str, Any]], str, Any]]): For failed actions, more information on the cause of the failure.
target: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a target EntryPoint, or url, for an Action.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
participant: (Optional[Union[List[Union[str, Any]], str, Any]]): Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.
toLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of location. The final location of the object or the agent after the action.
fromLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of location. The original location of the object or the agent before the action.
"""
type_: str = Field(default="TransferAction", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
result: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The result produced in the action. E.g. John wrote *a book*.",
)
actionStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the current disposition of the Action.",
)
agent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote"
"a book.",
)
instrument: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.",
)
object: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object upon which the action is carried out, whose state is kept intact or changed."
"Also known as the semantic roles patient, affected or undergoer (which change their"
"state) or theme (which doesn't). E.g. John read *a book*.",
)
error: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="For failed actions, more information on the cause of the failure.",
)
target: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates a target EntryPoint, or url, for an Action.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
participant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Other co-agents that participated in the action indirectly. E.g. John wrote a book with"
"*Steve*.",
)
toLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of location. The final location of the object or the agent after the action.",
)
fromLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of location. The original location of the object or the agent before the"
"action.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/TransferAction.py
|
TransferAction.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TransferAction(BaseModel):
"""The act of transferring/moving (abstract or concrete) animate or inanimate objects from one place to another.
References:
https://schema.org/TransferAction
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
result: (Optional[Union[List[Union[str, Any]], str, Any]]): The result produced in the action. E.g. John wrote *a book*.
actionStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the current disposition of the Action.
agent: (Optional[Union[List[Union[str, Any]], str, Any]]): The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.
instrument: (Optional[Union[List[Union[str, Any]], str, Any]]): The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.
object: (Optional[Union[List[Union[str, Any]], str, Any]]): The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read *a book*.
error: (Optional[Union[List[Union[str, Any]], str, Any]]): For failed actions, more information on the cause of the failure.
target: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a target EntryPoint, or url, for an Action.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
participant: (Optional[Union[List[Union[str, Any]], str, Any]]): Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.
toLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of location. The final location of the object or the agent after the action.
fromLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of location. The original location of the object or the agent before the action.
"""
type_: str = Field(default="TransferAction", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
result: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The result produced in the action. E.g. John wrote *a book*.",
)
actionStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the current disposition of the Action.",
)
agent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote"
"a book.",
)
instrument: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.",
)
object: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object upon which the action is carried out, whose state is kept intact or changed."
"Also known as the semantic roles patient, affected or undergoer (which change their"
"state) or theme (which doesn't). E.g. John read *a book*.",
)
error: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="For failed actions, more information on the cause of the failure.",
)
target: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates a target EntryPoint, or url, for an Action.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
participant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Other co-agents that participated in the action indirectly. E.g. John wrote a book with"
"*Steve*.",
)
toLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of location. The final location of the object or the agent after the action.",
)
fromLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of location. The original location of the object or the agent before the"
"action.",
)
| 0.91938 | 0.433502 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WPAdBlock(BaseModel):
"""An advertising section of the page.
References:
https://schema.org/WPAdBlock
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
xpath: (Union[List[Union[str, Any]], str, Any]): An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
cssSelector: (Union[List[Union[str, Any]], str, Any]): A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
"""
type_: str = Field(default="WPAdBlock", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
xpath: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter"
'case, multiple matches within a page can constitute a single conceptual "Web page element".',
)
cssSelector: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the"
'latter case, multiple matches within a page can constitute a single conceptual "Web'
'page element".',
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/WPAdBlock.py
|
WPAdBlock.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WPAdBlock(BaseModel):
"""An advertising section of the page.
References:
https://schema.org/WPAdBlock
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
xpath: (Union[List[Union[str, Any]], str, Any]): An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
cssSelector: (Union[List[Union[str, Any]], str, Any]): A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter case, multiple matches within a page can constitute a single conceptual "Web page element".
"""
type_: str = Field(default="WPAdBlock", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
xpath: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An XPath, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the latter"
'case, multiple matches within a page can constitute a single conceptual "Web page element".',
)
cssSelector: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A CSS selector, e.g. of a [[SpeakableSpecification]] or [[WebPageElement]]. In the"
'latter case, multiple matches within a page can constitute a single conceptual "Web'
'page element".',
)
| 0.927326 | 0.331228 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PaymentDeclined(BaseModel):
"""The payee received the payment, but it was declined for some reason.
References:
https://schema.org/PaymentDeclined
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="PaymentDeclined", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/PaymentDeclined.py
|
PaymentDeclined.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PaymentDeclined(BaseModel):
"""The payee received the payment, but it was declined for some reason.
References:
https://schema.org/PaymentDeclined
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="PaymentDeclined", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.944549 | 0.300726 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Musculoskeletal(BaseModel):
"""A specific branch of medical science that pertains to diagnosis and treatment of disorders of muscles, ligaments and skeletal system.
References:
https://schema.org/Musculoskeletal
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Musculoskeletal", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Musculoskeletal.py
|
Musculoskeletal.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Musculoskeletal(BaseModel):
"""A specific branch of medical science that pertains to diagnosis and treatment of disorders of muscles, ligaments and skeletal system.
References:
https://schema.org/Musculoskeletal
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="Musculoskeletal", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.93549 | 0.335174 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class GeoCoordinates(BaseModel):
"""The geographic coordinates of a place or event.
References:
https://schema.org/GeoCoordinates
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
elevation: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The elevation of a location ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be of the form 'NUMBER UNIT\_OF\_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') while numbers alone should be assumed to be a value in meters.
addressCountry: (Union[List[Union[str, Any]], str, Any]): The country. For example, USA. You can also provide the two-letter [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1).
postalCode: (Union[List[Union[str, Any]], str, Any]): The postal code. For example, 94043.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
"""
type_: str = Field(default="GeoCoordinates", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
elevation: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The elevation of a location ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System))."
"Values may be of the form 'NUMBER UNIT\_OF\_MEASUREMENT' (e.g., '1,000 m', '3,200 ft')"
"while numbers alone should be assumed to be a value in meters.",
)
addressCountry: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The country. For example, USA. You can also provide the two-letter [ISO 3166-1 alpha-2"
"country code](http://en.wikipedia.org/wiki/ISO_3166-1).",
)
postalCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The postal code. For example, 94043.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/GeoCoordinates.py
|
GeoCoordinates.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class GeoCoordinates(BaseModel):
"""The geographic coordinates of a place or event.
References:
https://schema.org/GeoCoordinates
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
elevation: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The elevation of a location ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). Values may be of the form 'NUMBER UNIT\_OF\_MEASUREMENT' (e.g., '1,000 m', '3,200 ft') while numbers alone should be assumed to be a value in meters.
addressCountry: (Union[List[Union[str, Any]], str, Any]): The country. For example, USA. You can also provide the two-letter [ISO 3166-1 alpha-2 country code](http://en.wikipedia.org/wiki/ISO_3166-1).
postalCode: (Union[List[Union[str, Any]], str, Any]): The postal code. For example, 94043.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
"""
type_: str = Field(default="GeoCoordinates", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
elevation: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The elevation of a location ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System))."
"Values may be of the form 'NUMBER UNIT\_OF\_MEASUREMENT' (e.g., '1,000 m', '3,200 ft')"
"while numbers alone should be assumed to be a value in meters.",
)
addressCountry: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The country. For example, USA. You can also provide the two-letter [ISO 3166-1 alpha-2"
"country code](http://en.wikipedia.org/wiki/ISO_3166-1).",
)
postalCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The postal code. For example, 94043.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
| 0.961795 | 0.653085 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WantAction(BaseModel):
"""The act of expressing a desire about the object. An agent wants an object.
References:
https://schema.org/WantAction
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
result: (Optional[Union[List[Union[str, Any]], str, Any]]): The result produced in the action. E.g. John wrote *a book*.
actionStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the current disposition of the Action.
agent: (Optional[Union[List[Union[str, Any]], str, Any]]): The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.
instrument: (Optional[Union[List[Union[str, Any]], str, Any]]): The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.
object: (Optional[Union[List[Union[str, Any]], str, Any]]): The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read *a book*.
error: (Optional[Union[List[Union[str, Any]], str, Any]]): For failed actions, more information on the cause of the failure.
target: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a target EntryPoint, or url, for an Action.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
participant: (Optional[Union[List[Union[str, Any]], str, Any]]): Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.
"""
type_: str = Field(default="WantAction", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
result: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The result produced in the action. E.g. John wrote *a book*.",
)
actionStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the current disposition of the Action.",
)
agent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote"
"a book.",
)
instrument: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.",
)
object: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object upon which the action is carried out, whose state is kept intact or changed."
"Also known as the semantic roles patient, affected or undergoer (which change their"
"state) or theme (which doesn't). E.g. John read *a book*.",
)
error: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="For failed actions, more information on the cause of the failure.",
)
target: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates a target EntryPoint, or url, for an Action.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
participant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Other co-agents that participated in the action indirectly. E.g. John wrote a book with"
"*Steve*.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/WantAction.py
|
WantAction.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WantAction(BaseModel):
"""The act of expressing a desire about the object. An agent wants an object.
References:
https://schema.org/WantAction
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
result: (Optional[Union[List[Union[str, Any]], str, Any]]): The result produced in the action. E.g. John wrote *a book*.
actionStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the current disposition of the Action.
agent: (Optional[Union[List[Union[str, Any]], str, Any]]): The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.
instrument: (Optional[Union[List[Union[str, Any]], str, Any]]): The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.
object: (Optional[Union[List[Union[str, Any]], str, Any]]): The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read *a book*.
error: (Optional[Union[List[Union[str, Any]], str, Any]]): For failed actions, more information on the cause of the failure.
target: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a target EntryPoint, or url, for an Action.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
participant: (Optional[Union[List[Union[str, Any]], str, Any]]): Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.
"""
type_: str = Field(default="WantAction", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
result: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The result produced in the action. E.g. John wrote *a book*.",
)
actionStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the current disposition of the Action.",
)
agent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote"
"a book.",
)
instrument: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.",
)
object: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object upon which the action is carried out, whose state is kept intact or changed."
"Also known as the semantic roles patient, affected or undergoer (which change their"
"state) or theme (which doesn't). E.g. John read *a book*.",
)
error: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="For failed actions, more information on the cause of the failure.",
)
target: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates a target EntryPoint, or url, for an Action.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
participant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Other co-agents that participated in the action indirectly. E.g. John wrote a book with"
"*Steve*.",
)
| 0.934178 | 0.411702 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MoneyTransfer(BaseModel):
"""The act of transferring money from one place to another place. This may occur electronically or physically.
References:
https://schema.org/MoneyTransfer
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
result: (Optional[Union[List[Union[str, Any]], str, Any]]): The result produced in the action. E.g. John wrote *a book*.
actionStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the current disposition of the Action.
agent: (Optional[Union[List[Union[str, Any]], str, Any]]): The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.
instrument: (Optional[Union[List[Union[str, Any]], str, Any]]): The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.
object: (Optional[Union[List[Union[str, Any]], str, Any]]): The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read *a book*.
error: (Optional[Union[List[Union[str, Any]], str, Any]]): For failed actions, more information on the cause of the failure.
target: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a target EntryPoint, or url, for an Action.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
participant: (Optional[Union[List[Union[str, Any]], str, Any]]): Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.
toLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of location. The final location of the object or the agent after the action.
fromLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of location. The original location of the object or the agent before the action.
amount: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The amount of money.
beneficiaryBank: (Union[List[Union[str, Any]], str, Any]): A bank or bankβs branch, financial institution or international financial institution operating the beneficiaryβs bank account or releasing funds for the beneficiary.
"""
type_: str = Field(default="MoneyTransfer", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
result: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The result produced in the action. E.g. John wrote *a book*.",
)
actionStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the current disposition of the Action.",
)
agent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote"
"a book.",
)
instrument: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.",
)
object: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object upon which the action is carried out, whose state is kept intact or changed."
"Also known as the semantic roles patient, affected or undergoer (which change their"
"state) or theme (which doesn't). E.g. John read *a book*.",
)
error: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="For failed actions, more information on the cause of the failure.",
)
target: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates a target EntryPoint, or url, for an Action.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
participant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Other co-agents that participated in the action indirectly. E.g. John wrote a book with"
"*Steve*.",
)
toLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of location. The final location of the object or the agent after the action.",
)
fromLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of location. The original location of the object or the agent before the"
"action.",
)
amount: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The amount of money.",
)
beneficiaryBank: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A bank or bankβs branch, financial institution or international financial institution"
"operating the beneficiaryβs bank account or releasing funds for the beneficiary.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MoneyTransfer.py
|
MoneyTransfer.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MoneyTransfer(BaseModel):
"""The act of transferring money from one place to another place. This may occur electronically or physically.
References:
https://schema.org/MoneyTransfer
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
endTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. E.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
startTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. E.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file.Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
result: (Optional[Union[List[Union[str, Any]], str, Any]]): The result produced in the action. E.g. John wrote *a book*.
actionStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the current disposition of the Action.
agent: (Optional[Union[List[Union[str, Any]], str, Any]]): The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote a book.
instrument: (Optional[Union[List[Union[str, Any]], str, Any]]): The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.
object: (Optional[Union[List[Union[str, Any]], str, Any]]): The object upon which the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). E.g. John read *a book*.
error: (Optional[Union[List[Union[str, Any]], str, Any]]): For failed actions, more information on the cause of the failure.
target: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a target EntryPoint, or url, for an Action.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
participant: (Optional[Union[List[Union[str, Any]], str, Any]]): Other co-agents that participated in the action indirectly. E.g. John wrote a book with *Steve*.
toLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of location. The final location of the object or the agent after the action.
fromLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of location. The original location of the object or the agent before the action.
amount: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The amount of money.
beneficiaryBank: (Union[List[Union[str, Any]], str, Any]): A bank or bankβs branch, financial institution or international financial institution operating the beneficiaryβs bank account or releasing funds for the beneficiary.
"""
type_: str = Field(default="MoneyTransfer", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
endTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to end. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from January to *December*. For media, including"
"audio and video, it's the time offset of the end of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
startTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation),"
"the time that it is expected to start. For actions that span a period of time, when the action"
"was performed. E.g. John wrote a book from *January* to December. For media, including"
"audio and video, it's the time offset of the start of a clip within a larger file.Note that"
"Event uses startDate/endDate instead of startTime/endTime, even when describing"
"dates with times. This situation may be clarified in future revisions.",
)
result: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The result produced in the action. E.g. John wrote *a book*.",
)
actionStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the current disposition of the Action.",
)
agent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The direct performer or driver of the action (animate or inanimate). E.g. *John* wrote"
"a book.",
)
instrument: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object that helped the agent perform the action. E.g. John wrote a book with *a pen*.",
)
object: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The object upon which the action is carried out, whose state is kept intact or changed."
"Also known as the semantic roles patient, affected or undergoer (which change their"
"state) or theme (which doesn't). E.g. John read *a book*.",
)
error: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="For failed actions, more information on the cause of the failure.",
)
target: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates a target EntryPoint, or url, for an Action.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
participant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Other co-agents that participated in the action indirectly. E.g. John wrote a book with"
"*Steve*.",
)
toLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of location. The final location of the object or the agent after the action.",
)
fromLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of location. The original location of the object or the agent before the"
"action.",
)
amount: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The amount of money.",
)
beneficiaryBank: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A bank or bankβs branch, financial institution or international financial institution"
"operating the beneficiaryβs bank account or releasing funds for the beneficiary.",
)
| 0.909546 | 0.379263 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class RestockingFees(BaseModel):
"""Specifies that the customer must pay a restocking fee when returning a product.
References:
https://schema.org/RestockingFees
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="RestockingFees", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/RestockingFees.py
|
RestockingFees.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class RestockingFees(BaseModel):
"""Specifies that the customer must pay a restocking fee when returning a product.
References:
https://schema.org/RestockingFees
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="RestockingFees", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.948597 | 0.333368 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class VenueMap(BaseModel):
"""A venue map (e.g. for malls, auditoriums, museums, etc.).
References:
https://schema.org/VenueMap
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="VenueMap", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/VenueMap.py
|
VenueMap.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class VenueMap(BaseModel):
"""A venue map (e.g. for malls, auditoriums, museums, etc.).
References:
https://schema.org/VenueMap
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="VenueMap", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.932376 | 0.316448 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BeautySalon(BaseModel):
"""Beauty salon.
References:
https://schema.org/BeautySalon
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
priceRange: (Union[List[Union[str, Any]], str, Any]): The price range of the business, for example ```$$$```.
currenciesAccepted: (Union[List[Union[str, Any]], str, Any]): The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
branchOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].
paymentAccepted: (Union[List[Union[str, Any]], str, Any]): Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
"""
type_: str = Field(default="BeautySalon", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
priceRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The price range of the business, for example ```$$$```.",
)
currenciesAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217),"
'e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)'
'for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
branchOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this local business is a branch of, if any. Not to be confused"
"with (anatomical) [[branch]].",
)
paymentAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/BeautySalon.py
|
BeautySalon.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BeautySalon(BaseModel):
"""Beauty salon.
References:
https://schema.org/BeautySalon
Note:
Model Depth 5
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
serviceArea: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where the service is provided.
founder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
hasPOS: (Optional[Union[List[Union[str, Any]], str, Any]]): Points-of-Sales operated by the organization or person.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
member: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals.
knowsAbout: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions.
makesOffer: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services offered by the organization or person.
ownershipFundingInfo: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable.
founders: (Optional[Union[List[Union[str, Any]], str, Any]]): A person who founded this organization.
legalName: (Union[List[Union[str, Any]], str, Any]): The official name of the organization, e.g. the registered company name.
actionableFeedbackPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroomβs), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
parentOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this organization is a [[subOrganization]] of, if any.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
department: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
memberOf: (Optional[Union[List[Union[str, Any]], str, Any]]): An Organization (or ProgramMembership) to which this Person or Organization belongs.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
employee: (Optional[Union[List[Union[str, Any]], str, Any]]): Someone working for this organization.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
email: (Union[List[Union[str, Any]], str, Any]): Email address.
contactPoints: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
diversityStaffingReport: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported.
foundingDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was founded.
owns: (Optional[Union[List[Union[str, Any]], str, Any]]): Products owned by the organization or person.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
dissolutionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date that this organization was dissolved.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
seeks: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to products or services sought by the organization or person (demand).
employees: (Optional[Union[List[Union[str, Any]], str, Any]]): People working for this organization.
unnamedSourcesPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required.
subOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property.
foundingLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The place where the Organization was founded.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
iso6523Code: (Union[List[Union[str, Any]], str, Any]): An organization identifier as defined in ISO 6523(-1). Note that many existing organization identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns) and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier by setting the ICD part of the ISO 6523 identifier accordingly.
diversityPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity policy on both staffing and sources, typically providing staffing data.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
duns: (Union[List[Union[str, Any]], str, Any]): The Dun & Bradstreet DUNS number for identifying an organization or business person.
alumni: (Optional[Union[List[Union[str, Any]], str, Any]]): Alumni of an organization.
ethicsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization.
leiCode: (Union[List[Union[str, Any]], str, Any]): An organization identifier that uniquely identifies a legal entity as defined in ISO 17442.
vatID: (Union[List[Union[str, Any]], str, Any]): The Value-added Tax ID of the organization or person.
knowsLanguage: (Union[List[Union[str, Any]], str, Any]): Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).
correctionsPolicy: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroomβs) disclosure and correction policy for errors.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
hasCredential: (Optional[Union[List[Union[str, Any]], str, Any]]): A credential awarded to the Person or Organization.
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
brand: (Optional[Union[List[Union[str, Any]], str, Any]]): The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
nonprofitStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): nonprofitStatus indicates the legal status of a non-profit organization in its primary place of business.
contactPoint: (Optional[Union[List[Union[str, Any]], str, Any]]): A contact point for a person or organization.
hasOfferCatalog: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an OfferCatalog listing for this Organization, Person, or Service.
members: (Optional[Union[List[Union[str, Any]], str, Any]]): A member of this organization.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
taxID: (Union[List[Union[str, Any]], str, Any]): The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain.
naics: (Union[List[Union[str, Any]], str, Any]): The North American Industry Classification System (NAICS) code for a particular organization or business person.
location: (Union[List[Union[str, Any]], str, Any]): The location of, for example, where an event is happening, where an organization is located, or where an action takes place.
numberOfEmployees: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of employees in an organization, e.g. business.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
geoCovers: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
longitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
smokingAllowed: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
isicV4: (Union[List[Union[str, Any]], str, Any]): The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
globalLocationNumber: (Union[List[Union[str, Any]], str, Any]): The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
amenityFeature: (Optional[Union[List[Union[str, Any]], str, Any]]): An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
additionalProperty: (Optional[Union[List[Union[str, Any]], str, Any]]): A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
photos: (Optional[Union[List[Union[str, Any]], str, Any]]): Photographs of this place.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
tourBookingPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.
geoWithin: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
containsPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and another that it contains.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
hasMap: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
containedIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
events: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past events associated with this place or organization.
geoOverlaps: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
geoEquals: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
maps: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
event: (Optional[Union[List[Union[str, Any]], str, Any]]): Upcoming or past event associated with this place, organization, or action.
photo: (Optional[Union[List[Union[str, Any]], str, Any]]): A photograph of this place.
containedInPlace: (Optional[Union[List[Union[str, Any]], str, Any]]): The basic containment relation between a place and one that contains it.
logo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An associated logo.
geoCrosses: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
address: (Union[List[Union[str, Any]], str, Any]): Physical address of the item.
geo: (Optional[Union[List[Union[str, Any]], str, Any]]): The geo coordinates of the place.
openingHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The opening hours of a certain place.
geoDisjoint: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoIntersects: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
latitude: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).
maximumAttendeeCapacity: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The total number of individuals that may attend an event or venue.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
map: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A URL to a map of the place.
branchCode: (Union[List[Union[str, Any]], str, Any]): A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
faxNumber: (Union[List[Union[str, Any]], str, Any]): The fax number.
publicAccess: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value
geoTouches: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)
geoCoveredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
telephone: (Union[List[Union[str, Any]], str, Any]): The telephone number.
hasDriveThroughService: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users.
specialOpeningHoursSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): The special opening hours of a certain place.Use this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].
geoContains: (Optional[Union[List[Union[str, Any]], str, Any]]): Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).
priceRange: (Union[List[Union[str, Any]], str, Any]): The price range of the business, for example ```$$$```.
currenciesAccepted: (Union[List[Union[str, Any]], str, Any]): The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217), e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types, e.g. "Ithaca HOUR".
branchOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The larger organization that this local business is a branch of, if any. Not to be confused with (anatomical) [[branch]].
paymentAccepted: (Union[List[Union[str, Any]], str, Any]): Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.
openingHours: (Union[List[Union[str, Any]], str, Any]): The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>.
"""
type_: str = Field(default="BeautySalon", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
serviceArea: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where the service is provided.",
)
founder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
hasPOS: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Points-of-Sales operated by the organization or person.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
member: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of an Organization or a ProgramMembership. Organizations can be members of"
"organizations; ProgramMembership is typically for individuals.",
)
knowsAbout: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that"
"is known about - suggesting possible expertise but not implying it. We do not distinguish"
"skill levels here, or relate this to educational content, events, objectives or [[JobPosting]]"
"descriptions.",
)
makesOffer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services offered by the organization or person.",
)
ownershipFundingInfo: Union[
List[Union[str, AnyUrl, Any]], str, AnyUrl, Any
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a description of organizational ownership structure; funding and grants. In a news/media"
"setting, this is with particular reference to editorial independence. Note that the"
"[[funder]] is also available and can be used to make basic funder information machine-readable.",
)
founders: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person who founded this organization.",
)
legalName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The official name of the organization, e.g. the registered company name.",
)
actionableFeedbackPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement"
"about public engagement activities (for news media, the newsroomβs), including involving"
"the public - digitally or otherwise -- in coverage decisions, reporting and activities"
"after publication.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
parentOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this organization is a [[subOrganization]] of, if any.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
department: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between an organization and a department of that organization, also"
"described as an organization (allowing different urls, logos, opening hours). For"
"example: a store with a pharmacy, or a bakery with a cafe.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
memberOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An Organization (or ProgramMembership) to which this Person or Organization belongs.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
employee: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Someone working for this organization.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
email: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Email address.",
)
contactPoints: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
diversityStaffingReport: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]),"
"a report on staffing diversity issues. In a news context this might be for example ASNE"
"or RTDNA (US) reports, or self-reported.",
)
foundingDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date that this organization was founded.",
)
owns: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Products owned by the organization or person.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
dissolutionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date that this organization was dissolved.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
seeks: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to products or services sought by the organization or person (demand).",
)
employees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People working for this organization.",
)
unnamedSourcesPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about"
"policy on use of unnamed sources and the decision process required.",
)
subOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A relationship between two organizations where the first includes the second, e.g.,"
"as a subsidiary. See also: the more specific 'department' property.",
)
foundingLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place where the Organization was founded.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
iso6523Code: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier as defined in ISO 6523(-1). Note that many existing organization"
"identifiers such as [leiCode](https://schema.org/leiCode), [duns](https://schema.org/duns)"
"and [vatID](https://schema.org/vatID) can be expressed as an ISO 6523 identifier"
"by setting the ICD part of the ISO 6523 identifier accordingly.",
)
diversityPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]."
"For a [[NewsMediaOrganization]], a statement describing the newsroomβs diversity"
"policy on both staffing and sources, typically providing staffing data.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
duns: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Dun & Bradstreet DUNS number for identifying an organization or business person.",
)
alumni: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Alumni of an organization.",
)
ethicsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic"
"and publishing practices, or of a [[Restaurant]], a page describing food source policies."
"In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement"
"describing the personal, organizational, and corporate standards of behavior expected"
"by the organization.",
)
leiCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An organization identifier that uniquely identifies a legal entity as defined in ISO"
"17442.",
)
vatID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Value-added Tax ID of the organization or person.",
)
knowsLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Of a [[Person]], and less typically of an [[Organization]], to indicate a known language."
"We do not distinguish skill levels or reading/writing/speaking/signing here. Use"
"language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47).",
)
correctionsPolicy: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing"
"(in news media, the newsroomβs) disclosure and correction policy for errors.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
hasCredential: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A credential awarded to the Person or Organization.",
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
brand: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The brand(s) associated with a product or service, or the brand(s) maintained by an organization"
"or business person.",
)
nonprofitStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="nonprofitStatus indicates the legal status of a non-profit organization in its primary"
"place of business.",
)
contactPoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A contact point for a person or organization.",
)
hasOfferCatalog: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an OfferCatalog listing for this Organization, Person, or Service.",
)
members: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A member of this organization.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
taxID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in"
"Spain.",
)
naics: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The North American Industry Classification System (NAICS) code for a particular organization"
"or business person.",
)
location: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of, for example, where an event is happening, where an organization is located,"
"or where an action takes place.",
)
numberOfEmployees: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of employees in an organization, e.g. business.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
geoCovers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a covering geometry to a covered geometry. "Every point of b is a point of (the interior'
'or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
longitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
smokingAllowed: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or"
"hotel room.",
)
isicV4: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The International Standard of Industrial Classification of All Economic Activities"
"(ISIC), Revision 4 code for a particular organization, business person, or place.",
)
globalLocationNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred"
"to as International Location Number or ILN) of the respective organization, person,"
"or place. The GLN is a 13-digit number used to identify parties and physical locations.",
)
amenityFeature: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic"
"property does not make a statement about whether the feature is included in an offer for"
"the main accommodation or available at extra costs.",
)
additionalProperty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A property-value pair representing an additional characteristic of the entity, e.g."
"a product feature or another characteristic for which there is no matching property"
"in schema.org.Note: Publishers should be aware that applications designed to use specific"
"schema.org properties (e.g. https://schema.org/width, https://schema.org/color,"
"https://schema.org/gtin13, ...) will typically expect such data to be provided using"
"those properties, rather than using the generic property/value mechanism.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
photos: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Photographs of this place.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
tourBookingPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]]"
"or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate.",
)
geoWithin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined"
"in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
containsPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and another that it contains.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
hasMap: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
containedIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
events: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past events associated with this place or organization.",
)
geoOverlaps: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that geospatially overlaps it, i.e. they have some but not all points"
"in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
geoEquals: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)."
'"Two geometries are topologically equal if their interiors intersect and no part of'
'the interior or boundary of one geometry intersects the exterior of the other" (a symmetric'
"relationship).",
)
maps: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
event: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Upcoming or past event associated with this place, organization, or action.",
)
photo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A photograph of this place.",
)
containedInPlace: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The basic containment relation between a place and one that contains it.",
)
logo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An associated logo.",
)
geoCrosses: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a geometry to another that crosses it: "a crosses b: they have some but not all interior'
"points in common, and the dimension of the intersection is less than that of at least one"
'of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).',
)
address: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Physical address of the item.",
)
geo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geo coordinates of the place.",
)
openingHoursSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The opening hours of a certain place.",
)
geoDisjoint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'are topologically disjoint: "they have no point in common. They form a set of disconnected'
'geometries." (A symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)',
)
geoIntersects: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
"have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
latitude: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)).",
)
maximumAttendeeCapacity: Optional[
Union[List[Union[str, int, Any]], str, int, Any]
] = Field(
default=None,
description="The total number of individuals that may attend an event or venue.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
map: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A URL to a map of the place.",
)
branchCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='A short textual code (also called "store code") that uniquely identifies a place of'
"business. The code is typically assigned by the parentOrganization and used in structured"
"URLs.For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047"
'the code "3047" is a branchCode for a particular branch.',
)
faxNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The fax number.",
)
publicAccess: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the [[Place]] is open to public visitors. If this property is omitted"
"there is no assumed default boolean value",
)
geoTouches: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents spatial relations in which two geometries (or the places they represent)"
'touch: "they have at least one boundary point in common, but no interior points." (A'
"symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).)",
)
geoCoveredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
"a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
telephone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The telephone number.",
)
hasDriveThroughService: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]])"
"offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]]"
"such facilities could potentially help with social distancing from other potentially-infected"
"users.",
)
specialOpeningHoursSpecification: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="The special opening hours of a certain place.Use this to explicitly override general"
"opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]].",
)
geoContains: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Represents a relationship between two geometries (or the places they represent), relating"
'a containing geometry to a contained geometry. "a contains b iff no points of b lie in'
'the exterior of a, and at least one point of the interior of b lies in the interior of a".'
"As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM).",
)
priceRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The price range of the business, for example ```$$$```.",
)
currenciesAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency accepted.Use standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217),"
'e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies)'
'for cryptocurrencies, e.g. "BTC"; well known names for [Local Exchange Trading Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system)'
'(LETS) and other currency types, e.g. "Ithaca HOUR".',
)
branchOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The larger organization that this local business is a branch of, if any. Not to be confused"
"with (anatomical) [[branch]].",
)
paymentAccepted: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Cash, Credit Card, Cryptocurrency, Local Exchange Tradings System, etc.",
)
openingHours: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The general opening hours for a business. Opening hours can be specified as a weekly time"
"range, starting with days, then times per day. Multiple days can be listed with commas"
"',' separating each day. Day or time ranges are specified using a hyphen '-'.* Days are"
"specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```,"
"```Th```, ```Fr```, ```Sa```, ```Su```.* Times are specified using 24:00 format."
"For example, 3pm is specified as ```15:00```, 10am as ```10:00```. * Here is an example:"
'<code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays'
"and Thursdays 4-8pm</time></code>.* If a business is open 7 days a week, then"
"it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday"
"through Sunday, all day</time></code>.",
)
| 0.865579 | 0.367582 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Grant(BaseModel):
"""A grant, typically financial or otherwise quantifiable, of resources. Typically a [[funder]] sponsors some [[MonetaryAmount]] to an [[Organization]] or [[Person]], sometimes not necessarily via a dedicated or long-lived [[Project]], resulting in one or more outputs, or [[fundedItem]]s. For financial sponsorship, indicate the [[funder]] of a [[MonetaryGrant]]. For non-financial support, indicate [[sponsor]] of [[Grant]]s of resources (e.g. office space).Grants support activities directed towards some agreed collective goals, often but not always organized as [[Project]]s. Long-lived projects are sometimes sponsored by a variety of grants over time, but it is also common for a project to be associated with a single grant.The amount of a [[Grant]] is represented using [[amount]] as a [[MonetaryAmount]].
References:
https://schema.org/Grant
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
fundedItem: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates something directly or indirectly funded or sponsored through a [[Grant]]. See also [[ownershipFundingInfo]].
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
"""
type_: str = Field(default="Grant", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
fundedItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates something directly or indirectly funded or sponsored through a [[Grant]]."
"See also [[ownershipFundingInfo]].",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Grant.py
|
Grant.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Grant(BaseModel):
"""A grant, typically financial or otherwise quantifiable, of resources. Typically a [[funder]] sponsors some [[MonetaryAmount]] to an [[Organization]] or [[Person]], sometimes not necessarily via a dedicated or long-lived [[Project]], resulting in one or more outputs, or [[fundedItem]]s. For financial sponsorship, indicate the [[funder]] of a [[MonetaryGrant]]. For non-financial support, indicate [[sponsor]] of [[Grant]]s of resources (e.g. office space).Grants support activities directed towards some agreed collective goals, often but not always organized as [[Project]]s. Long-lived projects are sometimes sponsored by a variety of grants over time, but it is also common for a project to be associated with a single grant.The amount of a [[Grant]] is represented using [[amount]] as a [[MonetaryAmount]].
References:
https://schema.org/Grant
Note:
Model Depth 3
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
fundedItem: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates something directly or indirectly funded or sponsored through a [[Grant]]. See also [[ownershipFundingInfo]].
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
"""
type_: str = Field(default="Grant", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
fundedItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates something directly or indirectly funded or sponsored through a [[Grant]]."
"See also [[ownershipFundingInfo]].",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
| 0.936278 | 0.373704 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EUEnergyEfficiencyCategoryA3Plus(BaseModel):
"""Represents EU Energy Efficiency Class A+++ as defined in EU energy labeling regulations.
References:
https://schema.org/EUEnergyEfficiencyCategoryA3Plus
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(
default="EUEnergyEfficiencyCategoryA3Plus", alias="@type", const=True
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/EUEnergyEfficiencyCategoryA3Plus.py
|
EUEnergyEfficiencyCategoryA3Plus.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EUEnergyEfficiencyCategoryA3Plus(BaseModel):
"""Represents EU Energy Efficiency Class A+++ as defined in EU energy labeling regulations.
References:
https://schema.org/EUEnergyEfficiencyCategoryA3Plus
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(
default="EUEnergyEfficiencyCategoryA3Plus", alias="@type", const=True
)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.943835 | 0.321247 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class VideoGameClip(BaseModel):
"""A short segment/part of a video game.
References:
https://schema.org/VideoGameClip
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
actors: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc. Actors can be associated with individual items or with a series, episode, clip.
actor: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.
clipNumber: (Union[List[Union[str, int, Any]], str, int, Any]): Position of the clip within an ordered group of clips.
partOfEpisode: (Optional[Union[List[Union[str, Any]], str, Any]]): The episode to which this clip belongs.
partOfSeason: (Optional[Union[List[Union[str, Any]], str, Any]]): The season to which this episode belongs.
startOffset: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The start time of the clip expressed as the number of seconds from the beginning of the work.
partOfSeries: (Optional[Union[List[Union[str, Any]], str, Any]]): The series to which this episode or season belongs.
endOffset: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The end time of the clip expressed as the number of seconds from the beginning of the work.
director: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.
directors: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video games etc. content. Directors can be associated with individual items or with a series, episode, clip.
musicBy: (Optional[Union[List[Union[str, Any]], str, Any]]): The composer of the soundtrack.
"""
type_: str = Field(default="VideoGameClip", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
actors: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc. Actors can be associated with individual"
"items or with a series, episode, clip.",
)
actor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated"
"with individual items or with a series, episode, clip.",
)
clipNumber: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="Position of the clip within an ordered group of clips.",
)
partOfEpisode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The episode to which this clip belongs.",
)
partOfSeason: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The season to which this episode belongs.",
)
startOffset: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The start time of the clip expressed as the number of seconds from the beginning of the"
"work.",
)
partOfSeries: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The series to which this episode or season belongs.",
)
endOffset: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The end time of the clip expressed as the number of seconds from the beginning of the work.",
)
director: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors"
"can be associated with individual items or with a series, episode, clip.",
)
directors: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video games etc. content. Directors can be associated"
"with individual items or with a series, episode, clip.",
)
musicBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The composer of the soundtrack.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/VideoGameClip.py
|
VideoGameClip.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class VideoGameClip(BaseModel):
"""A short segment/part of a video game.
References:
https://schema.org/VideoGameClip
Note:
Model Depth 4
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
workTranslation: (Optional[Union[List[Union[str, Any]], str, Any]]): A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese translation TΓ’y du kΓ½ bΓ¬nh khαΊ£o.
educationalLevel: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.
associatedMedia: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for encoding.
exampleOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): A creative work that this work is an example/instance/realization/derivation of.
releasedEvent: (Optional[Union[List[Union[str, Any]], str, Any]]): The place and time the release was issued, expressed as a PublicationEvent.
version: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The version of the CreativeWork embodied by a specified resource.
locationCreated: (Optional[Union[List[Union[str, Any]], str, Any]]): The location where the CreativeWork was created, which may not be the same as the location depicted in the CreativeWork.
acquireLicensePage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page documenting how licenses can be purchased or otherwise acquired, for the current item.
thumbnailUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A thumbnail image relevant to the Thing.
provider: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.
expires: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date the content expires and is no longer useful or available. For example a [[VideoObject]] or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]] fact check whose publisher wants to indicate that it may no longer be relevant (or helpful to highlight) after some date.
contentLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location depicted or described in the content. For example, the location in a photograph or painting.
educationalUse: (Union[List[Union[str, Any]], str, Any]): The purpose of a work in the context of education; for example, 'assignment', 'group work'.
copyrightHolder: (Optional[Union[List[Union[str, Any]], str, Any]]): The party holding the legal copyright to the CreativeWork.
accessibilityControl: (Union[List[Union[str, Any]], str, Any]): Identifies input methods that are sufficient to fully control the described resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).
maintainer: (Optional[Union[List[Union[str, Any]], str, Any]]): A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other [[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on "upstream" sources. When [[maintainer]] is applied to a specific version of something e.g. a particular version or packaging of a [[Dataset]], it is always possible that the upstream source has a different maintainer. The [[isBasedOn]] property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work.
educationalAlignment: (Optional[Union[List[Union[str, Any]], str, Any]]): An alignment to an established educational framework.This property should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
spatial: (Optional[Union[List[Union[str, Any]], str, Any]]): The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]], [[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.
publisher: (Optional[Union[List[Union[str, Any]], str, Any]]): The publisher of the creative work.
keywords: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
assesses: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to assess the competency or learning outcome defined by the referenced term.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
isBasedOn: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource from which this work is derived or from which it is a modification or adaption.
mentions: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept.
publishingPrinciples: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]].While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.
contributor: (Optional[Union[List[Union[str, Any]], str, Any]]): A secondary contributor to the CreativeWork or Event.
license: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this content, typically indicated by URL.
citation: (Union[List[Union[str, Any]], str, Any]): A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
accessibilitySummary: (Union[List[Union[str, Any]], str, Any]): A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed."
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
commentCount: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of comments this CreativeWork (e.g. Article, Question or Answer) has received. This is most applicable to works published in Web sites with commenting system; additional comments may exist elsewhere.
temporalCoverage: (Union[List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl]): The temporalCoverage of a CreativeWork indicates the period that the content applies to, i.e. that it describes, either as a DateTime or as a textual string indicating a time period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). In the case of a Dataset it will typically indicate the relevant time period in a precise notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012"). Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate their temporalCoverage in broader terms - textually or via well-known URL. Written works such as books may sometimes have precise temporal coverage too, e.g. a work set in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended date ranges can be written with ".." in place of the end date. For example, "2015-11/.." indicates a range beginning in November 2015 and with no specified final date. This is tentative and might be updated in future when ISO 8601 is officially updated.
dateCreated: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was created or the item was added to a DataFeed.
discussionUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A link to the page containing the comments of the CreativeWork.
copyrightNotice: (Union[List[Union[str, Any]], str, Any]): Text of a notice appropriate for describing the copyright aspects of this Creative Work, ideally indicating the owner of the copyright for the Work.
learningResourceType: (Union[List[Union[str, Any]], str, Any]): The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'.
awards: (Union[List[Union[str, Any]], str, Any]): Awards won by or for this item.
accessModeSufficient: (Optional[Union[List[Union[str, Any]], str, Any]]): A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
conditionsOfAccess: (Union[List[Union[str, Any]], str, Any]): Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language.For example "Available by appointment from the Reading Room" or "Accessible only from logged-in accounts ".
interactivityType: (Union[List[Union[str, Any]], str, Any]): The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'.
abstract: (Union[List[Union[str, Any]], str, Any]): An abstract is a short description that summarizes a [[CreativeWork]].
fileFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)) of the content, e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. Unregistered or niche file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia entry.
interpretedAsClaim: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to indicate a specific claim contained, implied, translated or refined from the content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can be indicated using [[claimInterpreter]].
text: (Union[List[Union[str, Any]], str, Any]): The textual content of this CreativeWork.
archivedAt: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible, but be archived by archival, journalistic, activist, or law enforcement organizations. In such cases, the referenced page may not directly publish the content.
alternativeHeadline: (Union[List[Union[str, Any]], str, Any]): A secondary title of the CreativeWork.
creditText: (Union[List[Union[str, Any]], str, Any]): Text that can be used to credit person(s) and/or organization(s) associated with a published Creative Work.
funding: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[Grant]] that directly or indirectly provide funding or sponsorship for this item. See also [[ownershipFundingInfo]].
interactionStatistic: (Optional[Union[List[Union[str, Any]], str, Any]]): The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used.
workExample: (Optional[Union[List[Union[str, Any]], str, Any]]): Example/instance/realization/derivation of the concept of this creative work. E.g. the paperback edition, first edition, or e-book.
about: (Optional[Union[List[Union[str, Any]], str, Any]]): The subject matter of the content.
encodings: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork.
funder: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports (sponsors) something through some kind of financial contribution.
video: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded video object.
isPartOf: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
pattern: (Union[List[Union[str, Any]], str, Any]): A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
editor: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person who edited the CreativeWork.
dateModified: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date on which the CreativeWork was most recently modified or when the item's entry was modified within a DataFeed.
translationOfWork: (Optional[Union[List[Union[str, Any]], str, Any]]): The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the Origin of Speciesβ.
creativeWorkStatus: (Union[List[Union[str, Any]], str, Any]): The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle.
isBasedOnUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A resource that was used in the creation of this resource. This term can be repeated for multiple sources. For example, http://example.com/great-multiplication-intro.html.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
isAccessibleForFree: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
author: (Optional[Union[List[Union[str, Any]], str, Any]]): The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
contentReferenceTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): The specific time described by a creative work, for works (e.g. articles, video objects etc.) that emphasise a particular moment within an Event.
correction: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]], textually or in another document.
sdDatePublished: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Indicates the date on which the current structured data was generated / published. Typically used alongside [[sdPublisher]]
comment: (Optional[Union[List[Union[str, Any]], str, Any]]): Comments, typically from users.
countryOfOrigin: (Optional[Union[List[Union[str, Any]], str, Any]]): The country of origin of something, including products as well as creative works such as movie and TV content.In the case of TV and movie, this would be the country of the principle offices of the production company or individual responsible for the movie. For other kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the case of products, the country of origin of the product. The exact interpretation of this may vary by context and product type, and cannot be fully enumerated here.
timeRequired: (Optional[Union[List[Union[str, Any]], str, Any]]): Approximate or typical time it takes to work with or through this learning resource for the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.
typicalAgeRange: (Union[List[Union[str, Any]], str, Any]): The typical expected age range, e.g. '7-9', '11-'.
genre: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Genre of the creative work, broadcast channel or group.
producer: (Optional[Union[List[Union[str, Any]], str, Any]]): The person or organization who produced the work (e.g. music album, movie, TV/radio series etc.).
schemaVersion: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Indicates (by URL or string) a particular version of a schema used in some CreativeWork. This property was created primarily to indicate the use of a specific schema.org release, e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```. There may be situations in which other schemas might usefully be referenced this way, e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/``` but this has not been carefully explored in the community.
audience: (Optional[Union[List[Union[str, Any]], str, Any]]): An intended audience, i.e. a group for whom something was created.
encoding: (Optional[Union[List[Union[str, Any]], str, Any]]): A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.
publisherImprint: (Optional[Union[List[Union[str, Any]], str, Any]]): The publishing division which published the comic.
accessibilityAPI: (Union[List[Union[str, Any]], str, Any]): Indicates that the resource is compatible with the referenced accessibility API. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).
sdPublisher: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The[[sdPublisher]] property helps make such practices more explicit.
audio: (Optional[Union[List[Union[str, Any]], str, Any]]): An embedded audio object.
accessibilityFeature: (Union[List[Union[str, Any]], str, Any]): Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).
spatialCoverage: (Optional[Union[List[Union[str, Any]], str, Any]]): The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of the content. It is a subproperty of contentLocation intended primarily for more technical and detailed materials. For example with a Dataset, it indicates areas that the dataset describes: a dataset of New York weather would have spatialCoverage which was the place: the state of New York.
accessMode: (Union[List[Union[str, Any]], str, Any]): The human sensory perceptual system or cognitive faculty through which a person may process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).
editEIDR: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]] representing a specific edit / edition for a work of film or television.For example, the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J" has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description), or alongside [[editEIDR]] for a more edit-specific description.
usageInfo: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]. This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
encodingFormat: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml) and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)), e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In cases where a [[CreativeWork]] has several media type representations, [[encoding]] can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]] information.Unregistered or niche encoding and file formats can be indicated instead via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.
copyrightYear: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The year during which the claimed copyright for the CreativeWork was first asserted.
mainEntity: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the primary entity described in some page or other CreativeWork.
creator: (Optional[Union[List[Union[str, Any]], str, Any]]): The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork.
teaches: (Union[List[Union[str, Any]], str, Any]): The item being described is intended to help a person learn the competency or learning outcome defined by the referenced term.
temporal: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): The "temporal" property can be used in cases where more specific properties(e.g. [[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]]) are not known to be appropriate.
size: (Union[List[Union[str, Any]], str, Any]): A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable.
translator: (Optional[Union[List[Union[str, Any]], str, Any]]): Organization or person who adapts a creative work to different languages, regional differences and technical requirements of a target market, or that translates during some event.
aggregateRating: (Optional[Union[List[Union[str, Any]], str, Any]]): The overall rating, based on a collection of reviews or ratings, of the item.
accountablePerson: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies the Person that is legally accountable for the CreativeWork.
accessibilityHazard: (Union[List[Union[str, Any]], str, Any]): A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).
contentRating: (Union[List[Union[str, Any]], str, Any]): Official rating of a piece of content—for example, 'MPAA PG-13'.
recordedAt: (Optional[Union[List[Union[str, Any]], str, Any]]): The Event where the CreativeWork was recorded. The CreativeWork may capture all or part of the event.
publication: (Optional[Union[List[Union[str, Any]], str, Any]]): A publication event associated with the item.
sdLicense: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A license document that applies to this structured data, typically indicated by URL.
headline: (Union[List[Union[str, Any]], str, Any]): Headline of the article.
materialExtent: (Union[List[Union[str, Any]], str, Any]): The quantity of the materials being described or an expression of the physical space they occupy.
inLanguage: (Union[List[Union[str, Any]], str, Any]): The language of the content or performance or used in an action. Please use one of the language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also [[availableLanguage]].
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
datePublished: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Date of first broadcast/publication.
offers: (Optional[Union[List[Union[str, Any]], str, Any]]): An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
hasPart: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
sourceOrganization: (Optional[Union[List[Union[str, Any]], str, Any]]): The Organization on whose behalf the creator was working.
sponsor: (Optional[Union[List[Union[str, Any]], str, Any]]): A person or organization that supports a thing through a pledge, promise, or financial contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.
character: (Optional[Union[List[Union[str, Any]], str, Any]]): Fictional person connected with a creative work.
actors: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc. Actors can be associated with individual items or with a series, episode, clip.
actor: (Optional[Union[List[Union[str, Any]], str, Any]]): An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated with individual items or with a series, episode, clip.
clipNumber: (Union[List[Union[str, int, Any]], str, int, Any]): Position of the clip within an ordered group of clips.
partOfEpisode: (Optional[Union[List[Union[str, Any]], str, Any]]): The episode to which this clip belongs.
partOfSeason: (Optional[Union[List[Union[str, Any]], str, Any]]): The season to which this episode belongs.
startOffset: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The start time of the clip expressed as the number of seconds from the beginning of the work.
partOfSeries: (Optional[Union[List[Union[str, Any]], str, Any]]): The series to which this episode or season belongs.
endOffset: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The end time of the clip expressed as the number of seconds from the beginning of the work.
director: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors can be associated with individual items or with a series, episode, clip.
directors: (Optional[Union[List[Union[str, Any]], str, Any]]): A director of e.g. TV, radio, movie, video games etc. content. Directors can be associated with individual items or with a series, episode, clip.
musicBy: (Optional[Union[List[Union[str, Any]], str, Any]]): The composer of the soundtrack.
"""
type_: str = Field(default="VideoGameClip", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
workTranslation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A work that is a translation of the content of this work. E.g. θ₯Ώιθ¨ has an English workTranslation"
"βJourney to the Westβ, a German workTranslation βMonkeys Pilgerfahrtβ and a Vietnamese"
"translation TÒy du ký bình khảo.",
)
educationalLevel: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The level in terms of progression through an educational or training context. Examples"
"of educational levels include 'beginner', 'intermediate' or 'advanced', and formal"
"sets of level indicators.",
)
associatedMedia: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for encoding.",
)
exampleOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A creative work that this work is an example/instance/realization/derivation of.",
)
releasedEvent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place and time the release was issued, expressed as a PublicationEvent.",
)
version: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The version of the CreativeWork embodied by a specified resource.",
)
locationCreated: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location where the CreativeWork was created, which may not be the same as the location"
"depicted in the CreativeWork.",
)
acquireLicensePage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page documenting how licenses can be purchased or otherwise acquired, for"
"the current item.",
)
thumbnailUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A thumbnail image relevant to the Thing.",
)
provider: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provider, service operator, or service performer; the goods producer."
"Another party (a seller) may offer those services or goods on behalf of the provider."
"A provider may also serve as the seller.",
)
expires: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date the content expires and is no longer useful or available. For example a [[VideoObject]]"
"or [[NewsArticle]] whose availability or relevance is time-limited, or a [[ClaimReview]]"
"fact check whose publisher wants to indicate that it may no longer be relevant (or helpful"
"to highlight) after some date.",
)
contentLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location depicted or described in the content. For example, the location in a photograph"
"or painting.",
)
educationalUse: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The purpose of a work in the context of education; for example, 'assignment', 'group"
"work'.",
)
copyrightHolder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The party holding the legal copyright to the CreativeWork.",
)
accessibilityControl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifies input methods that are sufficient to fully control the described resource."
"Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityControl-vocabulary).",
)
maintainer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A maintainer of a [[Dataset]], software package ([[SoftwareApplication]]), or other"
"[[Project]]. A maintainer is a [[Person]] or [[Organization]] that manages contributions"
"to, and/or publication of, some (typically complex) artifact. It is common for distributions"
'of software and data to be based on "upstream" sources. When [[maintainer]] is applied'
"to a specific version of something e.g. a particular version or packaging of a [[Dataset]],"
"it is always possible that the upstream source has a different maintainer. The [[isBasedOn]]"
"property can be used to indicate such relationships between datasets to make the different"
"maintenance roles clear. Similarly in the case of software, a package may have dedicated"
"maintainers working on integration into software distributions such as Ubuntu, as"
"well as upstream maintainers of the underlying work.",
)
educationalAlignment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An alignment to an established educational framework.This property should not be used"
"where the nature of the alignment can be described using a simple property, for example"
"to express that a resource [[teaches]] or [[assesses]] a competency.",
)
spatial: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description='The "spatial" property can be used in cases when more specific properties(e.g. [[locationCreated]],'
"[[spatialCoverage]], [[contentLocation]]) are not known to be appropriate.",
)
publisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publisher of the creative work.",
)
keywords: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Keywords or tags used to describe some item. Multiple textual entries in a keywords list"
"are typically delimited by commas, or by repeating the property.",
)
assesses: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to assess the competency or learning outcome defined"
"by the referenced term.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
isBasedOn: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A resource from which this work is derived or from which it is a modification or adaption.",
)
mentions: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates that the CreativeWork contains a reference to, but is not necessarily about"
"a concept.",
)
publishingPrinciples: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The publishingPrinciples property indicates (typically via [[URL]]) a document describing"
"the editorial principles of an [[Organization]] (or individual, e.g. a [[Person]]"
"writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity"
"policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles"
"are those of the party primarily responsible for the creation of the [[CreativeWork]].While"
"such policies are most typically expressed in natural language, sometimes related"
"information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology.",
)
contributor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A secondary contributor to the CreativeWork or Event.",
)
license: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this content, typically indicated by URL.",
)
citation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A citation or reference to another creative work, such as another publication, web page,"
"scholarly article, etc.",
)
accessibilitySummary: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A human-readable summary of specific accessibility features or deficiencies, consistent"
'with the other accessibility metadata but expressing subtleties such as "short descriptions'
'are present but long descriptions will be needed for non-visual users" or "short descriptions'
'are present and no long descriptions are needed."',
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
commentCount: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of comments this CreativeWork (e.g. Article, Question or Answer) has received."
"This is most applicable to works published in Web sites with commenting system; additional"
"comments may exist elsewhere.",
)
temporalCoverage: Union[
List[Union[datetime, str, Any, AnyUrl]], datetime, str, Any, AnyUrl
] = Field(
default=None,
description="The temporalCoverage of a CreativeWork indicates the period that the content applies"
"to, i.e. that it describes, either as a DateTime or as a textual string indicating a time"
"period in [ISO 8601 time interval format](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals)."
"In the case of a Dataset it will typically indicate the relevant time period in a precise"
'notation (e.g. for a 2011 census dataset, the year 2011 would be written "2011/2012").'
"Other forms of content, e.g. ScholarlyArticle, Book, TVSeries or TVEpisode, may indicate"
"their temporalCoverage in broader terms - textually or via well-known URL. Written"
"works such as books may sometimes have precise temporal coverage too, e.g. a work set"
'in 1939 - 1945 can be indicated in ISO 8601 interval format format via "1939/1945".Open-ended'
'date ranges can be written with ".." in place of the end date. For example, "2015-11/.."'
"indicates a range beginning in November 2015 and with no specified final date. This is"
"tentative and might be updated in future when ISO 8601 is officially updated.",
)
dateCreated: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was created or the item was added to a DataFeed.",
)
discussionUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A link to the page containing the comments of the CreativeWork.",
)
copyrightNotice: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of a notice appropriate for describing the copyright aspects of this Creative Work,"
"ideally indicating the owner of the copyright for the Work.",
)
learningResourceType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant type or kind characterizing the learning resource. For example, 'presentation',"
"'handout'.",
)
awards: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Awards won by or for this item.",
)
accessModeSufficient: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A list of single or combined accessModes that are sufficient to understand all the intellectual"
"content of a resource. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient-vocabulary).",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
conditionsOfAccess: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Conditions that affect the availability of, or method(s) of access to, an item. Typically"
"used for real world items such as an [[ArchiveComponent]] held by an [[ArchiveOrganization]]."
"This property is not suitable for use as a general Web access control mechanism. It is"
'expressed only in natural language.For example "Available by appointment from the'
'Reading Room" or "Accessible only from logged-in accounts ".',
)
interactivityType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The predominant mode of learning supported by the learning resource. Acceptable values"
"are 'active', 'expositive', or 'mixed'.",
)
abstract: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An abstract is a short description that summarizes a [[CreativeWork]].",
)
fileFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type, typically MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml))"
"of the content, e.g. application/zip of a SoftwareApplication binary. In cases where"
"a CreativeWork has several media type representations, 'encoding' can be used to indicate"
"each MediaObject alongside particular fileFormat information. Unregistered or niche"
"file formats can be indicated instead via the most appropriate URL, e.g. defining Web"
"page or a Wikipedia entry.",
)
interpretedAsClaim: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to indicate a specific claim contained, implied, translated or refined from the"
"content of a [[MediaObject]] or other [[CreativeWork]]. The interpreting party can"
"be indicated using [[claimInterpreter]].",
)
text: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The textual content of this CreativeWork.",
)
archivedAt: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page or other link involved in archival of a [[CreativeWork]]. In the case"
"of [[MediaReview]], the items in a [[MediaReviewItem]] may often become inaccessible,"
"but be archived by archival, journalistic, activist, or law enforcement organizations."
"In such cases, the referenced page may not directly publish the content.",
)
alternativeHeadline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A secondary title of the CreativeWork.",
)
creditText: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text that can be used to credit person(s) and/or organization(s) associated with a published"
"Creative Work.",
)
funding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[Grant]] that directly or indirectly provide funding or sponsorship for this item."
"See also [[ownershipFundingInfo]].",
)
interactionStatistic: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number of interactions for the CreativeWork using the WebSite or SoftwareApplication."
"The most specific child type of InteractionCounter should be used.",
)
workExample: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Example/instance/realization/derivation of the concept of this creative work. E.g."
"the paperback edition, first edition, or e-book.",
)
about: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The subject matter of the content.",
)
encodings: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork.",
)
funder: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports (sponsors) something through some kind of financial"
"contribution.",
)
video: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded video object.",
)
isPartOf: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is"
"part of.",
)
pattern: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'."
"Values are typically expressed as text, although links to controlled value schemes"
"are also supported.",
)
editor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person who edited the CreativeWork.",
)
dateModified: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date on which the CreativeWork was most recently modified or when the item's entry"
"was modified within a DataFeed.",
)
translationOfWork: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The work that this work has been translated from. E.g. η©η§θ΅·ζΊ is a translationOf βOn the"
"Origin of Speciesβ.",
)
creativeWorkStatus: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of a creative work in terms of its stage in a lifecycle. Example terms include"
"Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for"
"the stages of their publication lifecycle.",
)
isBasedOnUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A resource that was used in the creation of this resource. This term can be repeated for"
"multiple sources. For example, http://example.com/great-multiplication-intro.html.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
isAccessibleForFree: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="A flag to signal that the item, event, or place is accessible for free.",
)
author: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The author of this content or rating. Please note that author is special in that HTML 5"
"provides a special mechanism for indicating authorship via the rel tag. That is equivalent"
"to this and may be used interchangeably.",
)
contentReferenceTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="The specific time described by a creative work, for works (e.g. articles, video objects"
"etc.) that emphasise a particular moment within an Event.",
)
correction: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates a correction to a [[CreativeWork]], either via a [[CorrectionComment]],"
"textually or in another document.",
)
sdDatePublished: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="Indicates the date on which the current structured data was generated / published. Typically"
"used alongside [[sdPublisher]]",
)
comment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Comments, typically from users.",
)
countryOfOrigin: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The country of origin of something, including products as well as creative works such"
"as movie and TV content.In the case of TV and movie, this would be the country of the principle"
"offices of the production company or individual responsible for the movie. For other"
"kinds of [[CreativeWork]] it is difficult to provide fully general guidance, and properties"
"such as [[contentLocation]] and [[locationCreated]] may be more applicable.In the"
"case of products, the country of origin of the product. The exact interpretation of this"
"may vary by context and product type, and cannot be fully enumerated here.",
)
timeRequired: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Approximate or typical time it takes to work with or through this learning resource for"
"the typical intended target audience, e.g. 'PT30M', 'PT1H25M'.",
)
typicalAgeRange: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The typical expected age range, e.g. '7-9', '11-'.",
)
genre: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Genre of the creative work, broadcast channel or group.",
)
producer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The person or organization who produced the work (e.g. music album, movie, TV/radio"
"series etc.).",
)
schemaVersion: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Indicates (by URL or string) a particular version of a schema used in some CreativeWork."
"This property was created primarily to indicate the use of a specific schema.org release,"
"e.g. ```10.0``` as a simple string, or more explicitly via URL, ```https://schema.org/docs/releases.html#v10.0```."
"There may be situations in which other schemas might usefully be referenced this way,"
"e.g. ```http://dublincore.org/specifications/dublin-core/dces/1999-07-02/```"
"but this has not been carefully explored in the community.",
)
audience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An intended audience, i.e. a group for whom something was created.",
)
encoding: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A media object that encodes this CreativeWork. This property is a synonym for associatedMedia.",
)
publisherImprint: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The publishing division which published the comic.",
)
accessibilityAPI: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates that the resource is compatible with the referenced accessibility API. Values"
"should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityAPI-vocabulary).",
)
sdPublisher: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the party responsible for generating and publishing the current structured"
"data markup, typically in cases where the structured data is derived automatically"
"from existing published content but published on a different site. For example, student"
"projects and open data initiatives often re-publish existing content with more explicitly"
"structured metadata. The[[sdPublisher]] property helps make such practices more"
"explicit.",
)
audio: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An embedded audio object.",
)
accessibilityFeature: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Content features of the resource, such as accessible media, alternatives and supported"
"enhancements for accessibility. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityFeature-vocabulary).",
)
spatialCoverage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The spatialCoverage of a CreativeWork indicates the place(s) which are the focus of"
"the content. It is a subproperty of contentLocation intended primarily for more technical"
"and detailed materials. For example with a Dataset, it indicates areas that the dataset"
"describes: a dataset of New York weather would have spatialCoverage which was the place:"
"the state of New York.",
)
accessMode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The human sensory perceptual system or cognitive faculty through which a person may"
"process or perceive information. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode-vocabulary).",
)
editEIDR: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An [EIDR](https://eidr.org/) (Entertainment Identifier Registry) [[identifier]]"
"representing a specific edit / edition for a work of film or television.For example,"
'the motion picture known as "Ghostbusters" whose [[titleEIDR]] is "10.5240/7EC7-228A-510A-053E-CBB8-J"'
'has several edits, e.g. "10.5240/1F2A-E1C5-680A-14C6-E76B-I" and "10.5240/8A35-3BEE-6497-5D12-9E4F-3".Since'
"schema.org types like [[Movie]] and [[TVEpisode]] can be used for both works and their"
"multiple expressions, it is possible to use [[titleEIDR]] alone (for a general description),"
"or alongside [[editEIDR]] for a more edit-specific description.",
)
usageInfo: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The schema.org [[usageInfo]] property indicates further information about a [[CreativeWork]]."
"This property is applicable both to works that are freely available and to those that"
"require payment or other transactions. It can reference additional information, e.g."
"community expectations on preferred linking and citation conventions, as well as purchasing"
"details. For something that can be commercially licensed, usageInfo can provide detailed,"
"resource-specific information about licensing options.This property can be used"
"alongside the license property which indicates license(s) applicable to some piece"
"of content. The usageInfo property can provide information about other licensing options,"
"e.g. acquiring commercial usage rights for an image that is also available under non-commercial"
"creative commons licenses.",
)
position: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="The position of an item in a series or sequence of items.",
)
encodingFormat: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="Media type typically expressed using a MIME format (see [IANA site](http://www.iana.org/assignments/media-types/media-types.xhtml)"
"and [MDN reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types)),"
"e.g. application/zip for a SoftwareApplication binary, audio/mpeg for .mp3 etc.In"
"cases where a [[CreativeWork]] has several media type representations, [[encoding]]"
"can be used to indicate each [[MediaObject]] alongside particular [[encodingFormat]]"
"information.Unregistered or niche encoding and file formats can be indicated instead"
"via the most appropriate URL, e.g. defining Web page or a Wikipedia/Wikidata entry.",
)
copyrightYear: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The year during which the claimed copyright for the CreativeWork was first asserted.",
)
mainEntity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the primary entity described in some page or other CreativeWork.",
)
creator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The creator/author of this CreativeWork. This is the same as the Author property for"
"CreativeWork.",
)
teaches: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The item being described is intended to help a person learn the competency or learning"
"outcome defined by the referenced term.",
)
temporal: Union[List[Union[datetime, str, Any]], datetime, str, Any] = Field(
default=None,
description='The "temporal" property can be used in cases where more specific properties(e.g.'
"[[temporalCoverage]], [[dateCreated]], [[dateModified]], [[datePublished]])"
"are not known to be appropriate.",
)
size: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A standardized size of a product or creative work, specified either through a simple"
"textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode,"
"or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]],"
"[[height]], [[depth]] and [[weight]] properties may be more applicable.",
)
translator: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Organization or person who adapts a creative work to different languages, regional"
"differences and technical requirements of a target market, or that translates during"
"some event.",
)
aggregateRating: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The overall rating, based on a collection of reviews or ratings, of the item.",
)
accountablePerson: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies the Person that is legally accountable for the CreativeWork.",
)
accessibilityHazard: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A characteristic of the described resource that is physiologically dangerous to some"
"users. Related to WCAG 2.0 guideline 2.3. Values should be drawn from the [approved vocabulary](https://www.w3.org/2021/a11y-discov-vocab/latest/#accessibilityHazard-vocabulary).",
)
contentRating: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Official rating of a piece of content—for example, 'MPAA PG-13'.",
)
recordedAt: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Event where the CreativeWork was recorded. The CreativeWork may capture all or part"
"of the event.",
)
publication: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A publication event associated with the item.",
)
sdLicense: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="A license document that applies to this structured data, typically indicated by URL.",
)
headline: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Headline of the article.",
)
materialExtent: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The quantity of the materials being described or an expression of the physical space"
"they occupy.",
)
inLanguage: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The language of the content or performance or used in an action. Please use one of the language"
"codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). See also"
"[[availableLanguage]].",
)
material: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A material that something is made from, e.g. leather, wool, cotton, paper.",
)
datePublished: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Date of first broadcast/publication.",
)
offers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An offer to provide this item—for example, an offer to sell a product, rent the"
"DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]]"
"to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can"
"also be used to describe a [[Demand]]. While this property is listed as expected on a number"
"of common types, it can be used in others. In that case, using a second type, such as Product"
"or a subtype of Product, can clarify the nature of the offer.",
)
hasPart: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some"
"sense).",
)
sourceOrganization: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The Organization on whose behalf the creator was working.",
)
sponsor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A person or organization that supports a thing through a pledge, promise, or financial"
"contribution. E.g. a sponsor of a Medical Study or a corporate sponsor of an event.",
)
character: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Fictional person connected with a creative work.",
)
actors: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc. Actors can be associated with individual"
"items or with a series, episode, clip.",
)
actor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An actor, e.g. in TV, radio, movie, video games etc., or in an event. Actors can be associated"
"with individual items or with a series, episode, clip.",
)
clipNumber: Union[List[Union[str, int, Any]], str, int, Any] = Field(
default=None,
description="Position of the clip within an ordered group of clips.",
)
partOfEpisode: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The episode to which this clip belongs.",
)
partOfSeason: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The season to which this episode belongs.",
)
startOffset: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The start time of the clip expressed as the number of seconds from the beginning of the"
"work.",
)
partOfSeries: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The series to which this episode or season belongs.",
)
endOffset: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The end time of the clip expressed as the number of seconds from the beginning of the work.",
)
director: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video gaming etc. content, or of an event. Directors"
"can be associated with individual items or with a series, episode, clip.",
)
directors: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A director of e.g. TV, radio, movie, video games etc. content. Directors can be associated"
"with individual items or with a series, episode, clip.",
)
musicBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The composer of the soundtrack.",
)
| 0.925592 | 0.343232 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EUEnergyEfficiencyCategoryE(BaseModel):
"""Represents EU Energy Efficiency Class E as defined in EU energy labeling regulations.
References:
https://schema.org/EUEnergyEfficiencyCategoryE
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="EUEnergyEfficiencyCategoryE", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/EUEnergyEfficiencyCategoryE.py
|
EUEnergyEfficiencyCategoryE.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EUEnergyEfficiencyCategoryE(BaseModel):
"""Represents EU Energy Efficiency Class E as defined in EU energy labeling regulations.
References:
https://schema.org/EUEnergyEfficiencyCategoryE
Note:
Model Depth 6
Attributes:
potentialAction: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
mainEntityOfPage: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.
subjectOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork or Event about this Thing.
url: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of the item.
alternateName: (Union[List[Union[str, Any]], str, Any]): An alias for the item.
sameAs: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
description: (Union[List[Union[str, Any]], str, Any]): A description of the item.
disambiguatingDescription: (Union[List[Union[str, Any]], str, Any]): A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.
image: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].
name: (Union[List[Union[str, Any]], str, Any]): The name of the item.
additionalType: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
supersededBy: (Optional[Union[List[Union[str, Any]], str, Any]]): Relates a term (i.e. a property, class or enumeration) to one that supersedes it.
"""
type_: str = Field(default="EUEnergyEfficiencyCategoryE", alias="@type", const=True)
potentialAction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a potential Action, which describes an idealized action in which this thing"
"would play an 'object' role.",
)
mainEntityOfPage: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="Indicates a page (or other CreativeWork) for which this thing is the main entity being"
"described. See [background notes](/docs/datamodel.html#mainEntityBackground)"
"for details.",
)
subjectOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork or Event about this Thing.",
)
url: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of the item.",
)
alternateName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An alias for the item.",
)
sameAs: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="URL of a reference Web page that unambiguously indicates the item's identity. E.g. the"
"URL of the item's Wikipedia page, Wikidata entry, or official website.",
)
description: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A description of the item.",
)
disambiguatingDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of description. A short description of the item used to disambiguate from"
"other, similar items. Information from other properties (in particular, name) may"
"be necessary for the description to be useful for disambiguation.",
)
identifier: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="The identifier property represents any kind of identifier for any kind of [[Thing]],"
"such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for"
"representing many of these, either as textual strings or as URL (URI) links. See [background"
"notes](/docs/datamodel.html#identifierBg) for more details.",
)
image: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].",
)
name: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of the item.",
)
additionalType: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="An additional type for the item, typically used for adding more specific types from external"
"vocabularies in microdata syntax. This is a relationship between something and a class"
"that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof'"
"attribute - for multiple types. Schema.org tools may have only weaker understanding"
"of extra types, in particular those defined externally.",
)
supersededBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Relates a term (i.e. a property, class or enumeration) to one that supersedes it.",
)
| 0.943458 | 0.313236 |
# schemaorg Python
This module will serve functions for researchers and users to apply schema.org
definitions to their datasets, software, and other worldly things. For
development functions with Python along with the web interface that
serves the published specifications, please see [https://www.github.com/schemaorg/schemaorg](https://www.github.com/schemaorg/schemaorg).
For versions 0.1.0 and later, the structure of the data files changed, so we provide
schema.org 12.0 and later. For older versions of schemaorg, use versions prior
to 12.0.
## What is this not?
This library is not intended to provide advanced functions around querying the ontology,
but rather accessing the definitions and tagging content with them.
## What is this for?
Please reference the [development](https://openschemas.github.io/schemaorg/) documentation
to read about the intended use cases that we are working on.
## Organization
Generally, we are extracting metadata from datasets and software, and then shoving
that metadata into a specification from schema.org. The final thing that we produce
is likely to be some form of json (e.g., json-ld) that can be embedded in a web
page or similar, intended to power search. Since the specific needs of a particular
webby place may vary, along with a data type we are extracting, the module provides
"templates" in the [templates](schemaorg/templates) directory. Specifically:
- The subfolders represent different use cases. For example, [templates/google](schemaorg/templates/google) has a simple html template, and a requirements file (called a recipe) to produce a Dataset and SoftwareSourceCode.
- Each subfolder, in an optional `__init__.py` file, also contains helper functions toward this goal. For example, the same google subfolder has such a file with a `make_person` function that users can quickly use to generate a person object.
- For each corresponding subfolder, there is generally an example in the [examples](examples) folder that also helps to see how it works.
|
schemaorg
|
/schemaorg-0.1.1.tar.gz/schemaorg-0.1.1/README.md
|
README.md
|
# schemaorg Python
This module will serve functions for researchers and users to apply schema.org
definitions to their datasets, software, and other worldly things. For
development functions with Python along with the web interface that
serves the published specifications, please see [https://www.github.com/schemaorg/schemaorg](https://www.github.com/schemaorg/schemaorg).
For versions 0.1.0 and later, the structure of the data files changed, so we provide
schema.org 12.0 and later. For older versions of schemaorg, use versions prior
to 12.0.
## What is this not?
This library is not intended to provide advanced functions around querying the ontology,
but rather accessing the definitions and tagging content with them.
## What is this for?
Please reference the [development](https://openschemas.github.io/schemaorg/) documentation
to read about the intended use cases that we are working on.
## Organization
Generally, we are extracting metadata from datasets and software, and then shoving
that metadata into a specification from schema.org. The final thing that we produce
is likely to be some form of json (e.g., json-ld) that can be embedded in a web
page or similar, intended to power search. Since the specific needs of a particular
webby place may vary, along with a data type we are extracting, the module provides
"templates" in the [templates](schemaorg/templates) directory. Specifically:
- The subfolders represent different use cases. For example, [templates/google](schemaorg/templates/google) has a simple html template, and a requirements file (called a recipe) to produce a Dataset and SoftwareSourceCode.
- Each subfolder, in an optional `__init__.py` file, also contains helper functions toward this goal. For example, the same google subfolder has such a file with a `make_person` function that users can quickly use to generate a person object.
- For each corresponding subfolder, there is generally an example in the [examples](examples) folder that also helps to see how it works.
| 0.59408 | 0.952926 |
# Contributor's Agreement
This code is licensed under the Affero GPL, version 3.0 or later [LICENSE](../LICENSE).
The Affero GPL is a Copyleft license, meaning that it aims to ensure
that free and open software remains perpetually free and open by requiring
users of it to license their improvements under the same terms as the original.
If you make changes to the software and make the modified software available
to users within your organization (for example, students at a university)
via a network, this is considered propogation (not conveyance) and you
do not need to share your modifications. if you transfer copies of the
software to others, this **is** considered a conveyance.
# Contributing
When contributing to Python Puzzles, it is
important to properly communicate the gist of the contribution.
If it is a simple code or editorial fix, simply explaining this
within the GitHub Pull Request (PR) will suffice. But if this is a larger
fix or Enhancement, it should be first discussed with the project
leader or developers.
Please note we have a code of conduct, described below. Please follow it in
all your interactions with the project members and users.
## Pull Request Process
1. Bug fix PRs should be sent to both the master and development branches.
Feature enhancements should only be submitted against the development
branch.
2. Follow the existing code style precedent. This does not need to be strictly
defined as there are many thousands of lines of examples. Note the lack
of tabs anywhere in the project, parentheses and spacing, documentation
style, source code layout, variable scoping, and follow the project's
standards.
3. Test your PR locally, and provide the steps necessary to test for the
reviewers.
4. The project's default copyright and header have been included in any new
source files.
5. All (major) changes to Python Puzzles must be documented in
[docs](docs). If your PR changes a core functionality, please
include clear description of the changes in your PR so that the docs
can be updated, or better, submit another PR to update the docs directly.
6. If necessary, update the README.md.
7. The pull request will be reviewed by others, and the final merge must be
done by the project lead, @vsoch (or approved by her).
# Code of Conduct
See the [code of conduct](CODE_OF_CONDUCT.md)
|
schemaorg
|
/schemaorg-0.1.1.tar.gz/schemaorg-0.1.1/.github/CONTRIBUTING.md
|
CONTRIBUTING.md
|
# Contributor's Agreement
This code is licensed under the Affero GPL, version 3.0 or later [LICENSE](../LICENSE).
The Affero GPL is a Copyleft license, meaning that it aims to ensure
that free and open software remains perpetually free and open by requiring
users of it to license their improvements under the same terms as the original.
If you make changes to the software and make the modified software available
to users within your organization (for example, students at a university)
via a network, this is considered propogation (not conveyance) and you
do not need to share your modifications. if you transfer copies of the
software to others, this **is** considered a conveyance.
# Contributing
When contributing to Python Puzzles, it is
important to properly communicate the gist of the contribution.
If it is a simple code or editorial fix, simply explaining this
within the GitHub Pull Request (PR) will suffice. But if this is a larger
fix or Enhancement, it should be first discussed with the project
leader or developers.
Please note we have a code of conduct, described below. Please follow it in
all your interactions with the project members and users.
## Pull Request Process
1. Bug fix PRs should be sent to both the master and development branches.
Feature enhancements should only be submitted against the development
branch.
2. Follow the existing code style precedent. This does not need to be strictly
defined as there are many thousands of lines of examples. Note the lack
of tabs anywhere in the project, parentheses and spacing, documentation
style, source code layout, variable scoping, and follow the project's
standards.
3. Test your PR locally, and provide the steps necessary to test for the
reviewers.
4. The project's default copyright and header have been included in any new
source files.
5. All (major) changes to Python Puzzles must be documented in
[docs](docs). If your PR changes a core functionality, please
include clear description of the changes in your PR so that the docs
can be updated, or better, submit another PR to update the docs directly.
6. If necessary, update the README.md.
7. The pull request will be reviewed by others, and the final merge must be
done by the project lead, @vsoch (or approved by her).
# Code of Conduct
See the [code of conduct](CODE_OF_CONDUCT.md)
| 0.369543 | 0.491822 |
Releasing a New Version
=======================
0. Run `python setup.py test`
1. Change the MAJOR, MINOR, MICRO version numbers in `setup.py` as appropriate
2. Set `ISRELEASE=True` in `setup.py`
3. Run `python setup.py build sdist` to generate `schemaperfect/version.py`
4. Commit the changes and tag the release; e.g.
```
git add . -u
git commit -m "MAINT: release version 0.1"
git tag -a v0.1 -m "version 0.1 release"
```
and push tag to origin
5. Upload to PyPI (requires maintainer permissions) using `twine upload dist/schemaperfect-0.1.0.tar.gz`
6. Update to the next minor version in setup.py, and set `ISRELEASE=False`
7. Commit to master and push to origin
|
schemaperfect
|
/schemaperfect-0.5.0.tar.gz/schemaperfect-0.5.0/RELEASING.md
|
RELEASING.md
|
git add . -u
git commit -m "MAINT: release version 0.1"
git tag -a v0.1 -m "version 0.1 release"
| 0.369201 | 0.612339 |
# schemaperfect
Auto-generate Python APIs from JSON schema specifications
[](https://travis-ci.org/jwilson8767/schemaperfect)
## About
[JSON Schema](http://json-schema.org/) is a vocabulary that allows you to
annotate and validate JSON documents.
``schemaperfect`` lets you auto-generate simple Python object-based APIs given a valid JSON schema specification.
This is a living fork of the (now abandoned) [project "schemapi" by altair-viz](https://github.com/altair-viz/schemapi).
## Simple Example
As a very simple example, imagine you have the following simple JSON schema,
defined as a Python dictionary:
```python
schema = {
'properties': {
'name': {'type': 'string'},
'age': {'type': 'integer'}
}
}
```
This schema specifies that a data instance is valid if it has a key "name" that
maps to a string, and a key "age" that maps to an integer.
So, for example, this dictionary would be valid:
```python
valid = {'name': 'suzie', 'age': 32}
```
while this dictionary would not:
```python
invalid = {'name': 'suzie', 'age': 'old'}
```
### Validation with ``jsonschema``
In Python, you can use the ``jsonschema`` package (which is installed with schemaperfect automatically) to validate any data objects against this schema. For example, this data passes:
```python
jsonschema.validate(valid, schema)
```
While this data fails, as indicated by the ``ValidationError``:
```python
jsonschema.validate(invalid, schema) # raises ValidationError: 'old' is not of type 'integer'
```
### API Generation
The ``schemaperfect`` package lets you generate a Python API that allows you to build
up this kind of data not with raw dictionaries, but with an object-oriented
Python approach.
For example, here is how you can create a local module named ``myschema`` that
includes an object hierarchy designed for creating and validating data under
this schema:
```python
import schemaperfect
api = schemaperfect.SchemaModuleGenerator(schema, root_name='Person')
api.write_module('myschema.py')
```
The result of this is that a new Python module named ``myschema.py`` is written
to disk in the local directory; we can import the root object and use it to construct
some data:
```python
from myschema import Person
person = Person(name='suzie', age=32)
```
This data can be output in the form of a JSON dict:
```python
person.to_dict() # {'age': 32, 'name': 'suzie'}
```
The object can also be instantiated from a dict:
```python
person = Person.from_dict({'age': 32, 'name': 'suzie'})
```
The object allows data to be modified in-place using attribute access:
```python
person.name = 'frank'
person.to_dict() # {'age': 32, 'name': 'frank'}
```
When the object is created, its entries are validated using JSONSchema to ensure that they have the correct type:
```python
Person(name='Bob', age='old')
# SchemaValidationError: Invalid specification
# myschema.Person->age, validating 'type'
# 'old' is not of type 'integer'
```
To go a step further, the generated class `Person` can be extended and fit to new purposes:
```python
class User(Person):
_validate_on_instantiation = False # turns off invalidation at instantiation time, requiring we check .is_valid.
@property
def is_adult(self):
return self.age > 18
user = User(name="Jim", age=None)
# check if valid
print(user.is_valid) # false
# print the validation error
print(user.validation_exception) # SchemaValidationError: None is not of type 'integer'
#another way to check validity at runtime
user.to_dict(validate=True) # raises SchemaValidationError: None is not of type 'integer'
# fixing the issue
user.age = 33
print(user.is_valid) # true
# the special Undefined type.
```
By utilizing JSONSchema
[definitions and references](https://cswr.github.io/JsonSchema/spec/definitions_references/), much more complicated nested object hierarchies are possible, and the generated classes can be subclassed in order to create domain-specific APIs for specifying data that can be serialized to and from JSON.
## Dynamic Modules
If you do not wish to write a module to disk before importing it, you can construct the
module dynamically:
```python
import schemaperfect
api = schemaperfect.SchemaModuleGenerator(schema, root_name='Person')
dynamic_module = api.import_as('dynamic_module')
```
The module returned by this method can be used directly, or you can import from it as
with any Python module.
```python
from dynamic_module import Person
person = Person(name='suzie', age=32)
person.to_dict() # {'age': 32, 'name': 'suzie'}
```
Note, however, that the module lives only in memory, so it will
only be available in the Python session in which it is defined.
## Installation
You can install the released version from [PyPI](http://pypi.python.org/pypi/schemaperfect) using ``pip``:
$ pip install schemaperfect
To install the bleeding-edge version from source, you can download this
repository and installing locally:
$ git clone https://github.com/jwilson8767/schemaperfect.git
$ cd schemaperfect
$ pip install .
## Testing
To run the test suite you must have [py.test](http://pytest.org/latest/) installed.
To run the tests, use
```
py.test --pyargs schemaperfect
```
(you can omit the `--pyargs` flag if you are running the tests from a source checkout).
## License
``schemaperfect`` is released under a [3-Clause BSD License](LICENSE).
## Feedback and Contribution
We welcome any input, feedback, bug reports, and contributions via schemaperfect's
[GitHub repository](http://github.com/jwilson8767/schemaperfect/).
|
schemaperfect
|
/schemaperfect-0.5.0.tar.gz/schemaperfect-0.5.0/README.md
|
README.md
|
schema = {
'properties': {
'name': {'type': 'string'},
'age': {'type': 'integer'}
}
}
valid = {'name': 'suzie', 'age': 32}
invalid = {'name': 'suzie', 'age': 'old'}
jsonschema.validate(valid, schema)
jsonschema.validate(invalid, schema) # raises ValidationError: 'old' is not of type 'integer'
import schemaperfect
api = schemaperfect.SchemaModuleGenerator(schema, root_name='Person')
api.write_module('myschema.py')
from myschema import Person
person = Person(name='suzie', age=32)
person.to_dict() # {'age': 32, 'name': 'suzie'}
person = Person.from_dict({'age': 32, 'name': 'suzie'})
person.name = 'frank'
person.to_dict() # {'age': 32, 'name': 'frank'}
Person(name='Bob', age='old')
# SchemaValidationError: Invalid specification
# myschema.Person->age, validating 'type'
# 'old' is not of type 'integer'
class User(Person):
_validate_on_instantiation = False # turns off invalidation at instantiation time, requiring we check .is_valid.
@property
def is_adult(self):
return self.age > 18
user = User(name="Jim", age=None)
# check if valid
print(user.is_valid) # false
# print the validation error
print(user.validation_exception) # SchemaValidationError: None is not of type 'integer'
#another way to check validity at runtime
user.to_dict(validate=True) # raises SchemaValidationError: None is not of type 'integer'
# fixing the issue
user.age = 33
print(user.is_valid) # true
# the special Undefined type.
import schemaperfect
api = schemaperfect.SchemaModuleGenerator(schema, root_name='Person')
dynamic_module = api.import_as('dynamic_module')
from dynamic_module import Person
person = Person(name='suzie', age=32)
person.to_dict() # {'age': 32, 'name': 'suzie'}
py.test --pyargs schemaperfect
| 0.385722 | 0.945801 |
Releasing a New Version
=======================
1. Change the MAJOR, MINOR, MICRO version numbers in setup.py as appropriate
2. Set ISRELEASE=True in setup.py
3. Run
python setup.py build
to generate schemapi/version.py
4. Commit the changes and tag the release; e.g.
git add . -u
git commit -m "MAINT: release version 0.1"
git tag -a v0.1 -m "version 0.1 release"
and push tag to origin
5. Upload to PyPI (requires jakevdp's permissions)
python setup.py sdist upload
6. Update to the next minor version in setup.py, and set ISRELEASE=False
7. Commit to master and push to origin
|
schemapi
|
/schemapi-0.3.0.tar.gz/schemapi-0.3.0/RELEASING.md
|
RELEASING.md
|
Releasing a New Version
=======================
1. Change the MAJOR, MINOR, MICRO version numbers in setup.py as appropriate
2. Set ISRELEASE=True in setup.py
3. Run
python setup.py build
to generate schemapi/version.py
4. Commit the changes and tag the release; e.g.
git add . -u
git commit -m "MAINT: release version 0.1"
git tag -a v0.1 -m "version 0.1 release"
and push tag to origin
5. Upload to PyPI (requires jakevdp's permissions)
python setup.py sdist upload
6. Update to the next minor version in setup.py, and set ISRELEASE=False
7. Commit to master and push to origin
| 0.478529 | 0.332879 |
Schemapy
========
*Schemapy* allows you to generate objects for centralized database access. You
define the schema for your API, the code that needs to be executed, then the
validation part is dealt with for you. Everything is then encapsulated in a single
object.
*Schemapy* relies on PyDAL_ for schema definition but is not tied to it.
See documentation_ for more informations.
.. _documentation: https://schemapy.readthedocs.io
.. _PyDAL: https://github.com/web2py/pydal
.. image:: https://img.shields.io/pypi/l/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: License
.. image:: https://img.shields.io/pypi/status/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: Development Status
.. image:: https://img.shields.io/pypi/v/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: Latest release
.. image:: https://img.shields.io/pypi/pyversions/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: Supported Python versions
.. image:: https://img.shields.io/pypi/implementation/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: Supported Python implementations
.. image:: https://img.shields.io/pypi/wheel/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy
:alt: Download format
.. image:: https://travis-ci.org/link-society/schemapy.svg?branch=master&style=flat-square
:target: https://travis-ci.org/link-society/schemapy
:alt: Build status
.. image:: https://coveralls.io/repos/github/link-society/schemapy/badge.svg?style=flat-square
:target: https://coveralls.io/r/link-society/schemapy
:alt: Code test coverage
.. image:: https://landscape.io/github/link-society/schemapy/master/landscape.svg?style=flat-square
:target: https://landscape.io/github/link-society/schemapy/master
:alt: Code Health
Installation
------------
.. code-block:: text
pip install schemapy
Usage
-----
Using *PyDAL*:
.. code-block:: python
from schemapy import API, DAL, Field
from datetime import datetime, timedelta
db = DAL('sqlite:memory')
db.define_table(
'users',
Field('name', type='string', required=True),
Field('created_on', type='date')
)
db.define_table(
'posts',
Field('subject', type='string', required=True),
Field('author', type='reference users', required=True),
Field('created_on', type='date'),
Field('content', type='text', required=True)
)
api = API(db)
@api.as_action(
type='read',
request=[
Field('begin', type='date', required=True),
Field('end', type='date', required=True)
],
response=db.posts
)
def select_posts_by_date(db, req, action):
query = (db.posts.created_on >= req.begin) | (db.posts.created_on <= req.end)
return db(query).select()
now = datetime.now()
result = api.select_posts_by_date(
begin=now - timedelta(days=1),
end=now
)
print(list(result))
|
schemapy
|
/schemapy-0.2.4.tar.gz/schemapy-0.2.4/README.rst
|
README.rst
|
Schemapy
========
*Schemapy* allows you to generate objects for centralized database access. You
define the schema for your API, the code that needs to be executed, then the
validation part is dealt with for you. Everything is then encapsulated in a single
object.
*Schemapy* relies on PyDAL_ for schema definition but is not tied to it.
See documentation_ for more informations.
.. _documentation: https://schemapy.readthedocs.io
.. _PyDAL: https://github.com/web2py/pydal
.. image:: https://img.shields.io/pypi/l/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: License
.. image:: https://img.shields.io/pypi/status/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: Development Status
.. image:: https://img.shields.io/pypi/v/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: Latest release
.. image:: https://img.shields.io/pypi/pyversions/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: Supported Python versions
.. image:: https://img.shields.io/pypi/implementation/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy/
:alt: Supported Python implementations
.. image:: https://img.shields.io/pypi/wheel/schemapy.svg?style=flat-square
:target: https://pypi.python.org/pypi/schemapy
:alt: Download format
.. image:: https://travis-ci.org/link-society/schemapy.svg?branch=master&style=flat-square
:target: https://travis-ci.org/link-society/schemapy
:alt: Build status
.. image:: https://coveralls.io/repos/github/link-society/schemapy/badge.svg?style=flat-square
:target: https://coveralls.io/r/link-society/schemapy
:alt: Code test coverage
.. image:: https://landscape.io/github/link-society/schemapy/master/landscape.svg?style=flat-square
:target: https://landscape.io/github/link-society/schemapy/master
:alt: Code Health
Installation
------------
.. code-block:: text
pip install schemapy
Usage
-----
Using *PyDAL*:
.. code-block:: python
from schemapy import API, DAL, Field
from datetime import datetime, timedelta
db = DAL('sqlite:memory')
db.define_table(
'users',
Field('name', type='string', required=True),
Field('created_on', type='date')
)
db.define_table(
'posts',
Field('subject', type='string', required=True),
Field('author', type='reference users', required=True),
Field('created_on', type='date'),
Field('content', type='text', required=True)
)
api = API(db)
@api.as_action(
type='read',
request=[
Field('begin', type='date', required=True),
Field('end', type='date', required=True)
],
response=db.posts
)
def select_posts_by_date(db, req, action):
query = (db.posts.created_on >= req.begin) | (db.posts.created_on <= req.end)
return db(query).select()
now = datetime.now()
result = api.select_posts_by_date(
begin=now - timedelta(days=1),
end=now
)
print(list(result))
| 0.845911 | 0.333435 |
# SchemaQL
A testing and auditing tool inspired by dbt, for those not using [dbt](https://www.getdbt.com).
## Installation
1. Fork and clone to repo to a local folder.
2. Create a new Python virtual environment in this folder and activate it.
3. In the local repo folder, run `pip install -r requirements` to install the dependent packages in this virtualenv.
4. In the local repo folder, run `pip install -e .` to install a dev version locally.
You should now be able to run `schemaql -h` from the command line.
```bash
schemaql -h
usage: schemaql [-h] [-p None] [-c config.yml] [-x connections.yml] [action]
positional arguments:
action Action ('test', or 'generate')
optional arguments:
-h, --help show this help message and exit
-p None, --project None
Project
-c config.yml, --config-file config.yml
Config file
-x connections.yml, --connections-file connections.yml
Connections file
```
## Configuration
SchemaQL needs to `*.yml` for configuration:
In `connections.yml` you define how to connect to one or more of your data warehouse connections like so:
```yaml
project-1-snowflake:
type: snowflake
account: <my_account>
user: <my_user>
password: <my_password>
database: <my_database>
# optional:
warehouse: <my_warehouse>
role: <my_role>
schema: <my_initial_schema>
project-2-bigquery:
type: bigquery
database: <my_bigquery_project>
credentials_path: <path_to_my_service_account_credentials.json>
```
In `config.yml`, you define the following
- a `collector` which is a definition for how you want test results to be collected. Currently only 'json` is supported
- `projects` which is a combination of a connection and a list of which databases and schemas you want to work with. If you don't define any schemas within the database key, all schemas will be processed.
```yaml
collector:
type: json
output: output
projects:
project-1:
connection: project-1-snowflake
schema:
database_1:
- schema_1
- schema_2
project-2:
connection: project-2-bigquery
schema:
my_bg_project_1
my_bg_project_2
- data_set_1
- data_set_2
```
## Usage
### Generate
SchemaQL runs tests against schema information contained in `yml` files. You can either write these from scratch, use your existing `dbt` schema files, or use `schemaql` to generate them.
Generates schema files for all projects:
```bash
schemaql generate
```
Generates schema files for `"my_project"` only:
```bash
schemaql generate -p"my_project"
```
### Test
```bash
schemaql test
```
Test `"my_project"` only:
```bash
schemaql test -p"my_project"
```
## Built-in Tests
### Schema Tests
#### not_null
#### relationships
#### unique
### Data Tests
#### accepted_values
#### at_least_one
#### equal_expression (TBD)
#### frequency (TBD)
#### not_constant
#### recency (TBD)
#### unique_rows
|
schemaql
|
/schemaql-0.0.2a1.tar.gz/schemaql-0.0.2a1/README.md
|
README.md
|
schemaql -h
usage: schemaql [-h] [-p None] [-c config.yml] [-x connections.yml] [action]
positional arguments:
action Action ('test', or 'generate')
optional arguments:
-h, --help show this help message and exit
-p None, --project None
Project
-c config.yml, --config-file config.yml
Config file
-x connections.yml, --connections-file connections.yml
Connections file
project-1-snowflake:
type: snowflake
account: <my_account>
user: <my_user>
password: <my_password>
database: <my_database>
# optional:
warehouse: <my_warehouse>
role: <my_role>
schema: <my_initial_schema>
project-2-bigquery:
type: bigquery
database: <my_bigquery_project>
credentials_path: <path_to_my_service_account_credentials.json>
collector:
type: json
output: output
projects:
project-1:
connection: project-1-snowflake
schema:
database_1:
- schema_1
- schema_2
project-2:
connection: project-2-bigquery
schema:
my_bg_project_1
my_bg_project_2
- data_set_1
- data_set_2
schemaql generate
schemaql generate -p"my_project"
schemaql test
schemaql test -p"my_project"
| 0.402744 | 0.773644 |
The MIT License (MIT)
=====================
Copyright Β© 2022-present celsius narhwal
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the βSoftwareβ), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED βAS ISβ, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
|
schemarin
|
/schemarin-1.0.4.tar.gz/schemarin-1.0.4/LICENSE.md
|
LICENSE.md
|
The MIT License (MIT)
=====================
Copyright Β© 2022-present celsius narhwal
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the βSoftwareβ), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED βAS ISβ, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
| 0.810966 | 0.296807 |
# Schemasheets - make datamodels using spreadsheets
<p align="center">
<a href="https://github.com/linkml/schemasheets/actions/workflows/main.yml">
<img alt="Tests" src="https://github.com/linkml/schemasheets/actions/workflows/main.yaml/badge.svg" />
</a>
<a href="https://pypi.org/project/linkml">
<img alt="PyPI" src="https://img.shields.io/pypi/v/linkml" />
</a>
<a href="https://pypi.org/project/sssom">
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/sssom" />
</a>
<a href="https://github.com/linkml/schemasheets/blob/main/LICENSE">
<img alt="PyPI - License" src="https://img.shields.io/pypi/l/sssom" />
</a>
<a href="https://github.com/psf/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
</a>
</p>
Create a [data dictionary](https://linkml.io/schemasheets/howto/data-dictionaries/) / schema for your data using simple spreadsheets - *no coding required*.
## About
Schemasheets is a framework for managing your schema using
spreadsheets ([Google Sheets](https://linkml.io/schemasheets/howto/google-sheets/), [Excel](https://linkml.io/schemasheets/howto/excel/)). It works by compiling down to
[LinkML](https://linkml.io), which can itself be compiled to a variety
of formalisms, or used for different purposes like data validation
- [installation](https://linkml.io/schemasheets/install/)
- [basics](https://linkml.io/schemasheets/intro/basics/)
## Documentation
See the [Schema Sheets Manual](https://linkml.io/schemasheets)
## Quick Start
```bash
pip install schemasheets
```
You should then be able to run the following commands:
- sheets2linkml - Convert schemasheets to a LinkML schema
- linkml2sheets - Convert a LinkML schema to schemasheets
- sheets2project - Generate an entire set of schema files (JSON-Schema, SHACL, SQL, ...) from Schemasheets
As an example, take a look at the different tabs in the google sheet with ID [1wVoaiFg47aT9YWNeRfTZ8tYHN8s8PAuDx5i2HUcDpvQ](https://docs.google.com/spreadsheets/d/1wVoaiFg47aT9YWNeRfTZ8tYHN8s8PAuDx5i2HUcDpvQ/edit#gid=55566104)
The personinfo tab contains the bulk of the metadata elements:
|record|field|key|multiplicity|range|desc|schema.org|
|---|---|---|---|---|---|---|
|`>` class|slot|identifier|cardinality|range|description|exact_mappings: {curie_prefix: sdo}|
|`>`|||||||
||id|yes|1|string|any identifier|identifier|
||description|no|0..1|string|a textual description|description|
|Person||n/a|n/a|n/a|a person,living or dead|Person|
|Person|id|yes|1|string|identifier for a person|identifier|
|Person, Organization|name|no|1|string|full name|name|
|Person|age|no|0..1|decimal|age in years||
|Person|gender|no|0..1|decimal|age in years||
|Person|has medical history|no|0..*|MedicalEvent|medical history||
|Event|||||grouping class for events||
|MedicalEvent||n/a|n/a|n/a|a medical encounter||
|ForProfit|||||||
|NonProfit|||||||
This demonstrator schema contains both *record types* (e.g Person, MedicalEvent) as well as *fields* (e.g. id, age, gender)
You can convert this like this:
```bash
sheets2linkml --gsheet-id 1wVoaiFg47aT9YWNeRfTZ8tYHN8s8PAuDx5i2HUcDpvQ personinfo types prefixes -o personinfo.yaml
```
This will generate a LinkML YAML file `personinfo.yaml` from 3 of the tabs in the google sheet
You can also work directly with TSVs:
```
wget https://raw.githubusercontent.com/linkml/schemasheets/main/tests/input/personinfo.tsv
sheets2linkml personinfo.tsv -o personinfo.yaml
```
We recommend using [COGS](https://linkml.io/schemasheets/howto/google-sheets/) to synchronize your google sheets with local files using a git-like mechanism
## Finding out more
* [Schema Sheets Manual](https://linkml.io/schemasheets)
* [Specification](https://linkml.io/schemasheets/specification/)
* [Internal Datamodel](https://linkml.io/schemasheets/datamodel/)
* [linkml/schemasheets](https://github.com/linkml/schemasheets) code repo
* [linkml/linkml](https://github.com/linkml/linkml) main LinkML repo
|
schemasheets
|
/schemasheets-0.1.23.tar.gz/schemasheets-0.1.23/README.md
|
README.md
|
pip install schemasheets
sheets2linkml --gsheet-id 1wVoaiFg47aT9YWNeRfTZ8tYHN8s8PAuDx5i2HUcDpvQ personinfo types prefixes -o personinfo.yaml
wget https://raw.githubusercontent.com/linkml/schemasheets/main/tests/input/personinfo.tsv
sheets2linkml personinfo.tsv -o personinfo.yaml
| 0.568176 | 0.90101 |
# Schemata
Schemata is a file format that makes it easier to create schemas for XML and JSON files.
## Motivation
Schemata was created because many of the existing formats for XML schema are verbose. Among these is XSD. XSD, while flexible, requires a lot of mark-up (because it is an XML format) and is difficult to read. XSD files can easily become very large, and very disordered. This makes them difficult and tedious to maintain.
The Schemata format uses minimal, intuitive mark-up, making it easy to read and maintain. This is particularly useful when creating and maintaining schemas for multiple complex formats.
While Schemata was originally designed for XML schemas, it became apparent that the same format could also be used to define JSON schemas. Support for this has been added.
## How does it work?
This code library does not actually _perform_ the validation of an XML or JSON file against the schema itself. Instead, this code library generates an XSD or JSON Schemas file that can be used for validation. The validation can then be _performed_ by any number of standard libraries. This has the advantage that the code library is easy to maintain, and its output is portable.
This code library can also generate documentation for an XML or JSON format based on the Schemata file. This documentation is not _quite_ perfect - there will always be nuances in how an XML or JSON format is used that cannot be accounted for in the schema - but generating the documentation from the Schemata file and then editing it can be **a lot** quicker than writing the whole thing manually.
## An Introduction to the Syntax
Let's start by considering a very simple XML file.
```xml
<?xml version="1.0" encoding="utf-8" ?>
<books>
<book id="the_fellowship_of_the_ring">
<title>The Fellowship of the Ring</title>
<subtitle>The Lord of the Rings, Book 1</subtitle>
<isbn>0261103571</isbn>
</book>
<book id="pride_and_prejudice">
<title>Pride and Prejudice</title>
<subtitle></subtitle>
<isbn>9780141040349</isbn>
</book>
<book id="a_game_of_thrones">
<title>A Game of Thrones</title>
<subtitle>A Song of Ice and Fire, Book 1</subtitle>
<isbn>9780006479888</isbn>
</book>
</books>
```
This XML file contains a list of books, with some basic information about each book. We can call this XML format Book List XML.
In writing a schema for Book List XML, we might start by defining the root element `<books>`, which we can do in Schemata syntax as below.
```
root element books {
}
```
This code block states that in Book List XML there can be an element `<books>`, and that this element can be a root element of the document. We haven't said anything about the contents of this element yet, because we haven't defined any other elements in our Schemata file.
Note that the string that appears after `root element` in the code block above defines both the _reference_ to this structure in the Schemata file (the name by which this structure is referred to in the rest of the Schemata file), and the _tag name_ of the XML element. These two things can be set differently, as shown below.
```
root element my_root_element {
tagName: 'books';
}
```
This code block still states that in Book List XML there can be a root element `<books>`, but if we need to refer to it elsewhere in the Schemata file, it will be referred to as `my_root_element`. (Most of the time you won't want to have the reference and the tag name be different - it's only when schemas get much more complicated that you might need to.)
We now want to define an element `<book>` that has an `id` attribute. We need to first define the `id` attribute, which we can do in Schemata syntax as below.
```
attribute id {
valueType: string;
}
```
This code block states that in Book List XML there can be an attribute `id`, the value of which can be any string. We can now define the `<book>` element.
```
element book {
attributes: id;
}
```
This code block states that in Book List XML there can be an element `<book>`, which has an attribute `id`. (In this case it is a required attribute.)
Now we want to say that this `<book>` element can be a subelement of the `<books>` element. In order to do this, we need to adjust the first code block we wrote, as below.
```
root element books {
allowedContent: [ book (n >= 0) ];
}
```
This code block now states that the `<books>` element can have `<book>` subelements. The expression `n >= 0` indicates that there can be any number of `<book>` subelements, including zero. (That wouldn't be a very useful file, but we'll allow it.) The square brackets in the `allowedContent` property indicate that the subelements must appear in the order defined. This doesn't really matter in this case, as only one type of subelement - the `<book>` subelement - can exist. This becomes more useful when an element can have many different types of subelement (as we shall see later).
So far we have
```
root element books {
allowedContent: [ book (n >= 0) ];
}
attribute id {
valueType: string;
}
element book {
attributes: id;
}
```
At this point it's worth mentioning that we can be more specific with what values things like attributes can have. This can be done through data types.
In our example XML file above, we can see that the ids of the books always consist of letters, numbers, and underscores - never spaces, hyphens, apostrophes, et cetera. We can define a new data type in Schemata as below.
```
dataType _id {
baseType: string;
allowedPattern: '[A-Za-z0-9_]+';
}
```
This code block defines a new data type `_id`. (By convention, it's a good idea to start data type references with an underscore, to prevent clashes with attribute structures.) In this case we have stated that the base type of this new data type is a string, and then we've stated that this string must conform to the given regular expression. Putting this all together, we get
```
root element books {
allowedContent: [ book (n >= 0) ];
}
dataType _id {
baseType: string;
allowedPattern: '[A-Za-z0-9_]+';
}
attribute id {
valueType: _id;
}
element book {
attributes: id;
}
```
We now want to define the possible subelements of the `<book>` element. Let's start with the `<title>` element.
```
element title {
allowedContent: *any text*;
}
```
In this case, we want to allow the element to contain any text, but no subelements. We do this with `*any text*`.
The `<subtitle>` and `<isbn>` elements we can define to work in the same way.
```
element subtitle {
allowedContent: *any text*;
}
element isbn {
allowedContent: *any text*;
}
```
Finally, we need to 'attach' these subelements to the `<book>` element - i.e., we need to state that they are possible subelements. We can do this by editing the definition of the `<book>` structure.
```
element book {
attributes: id;
allowedContent: [ title, subtitle (optional), isbn ];
}
```
Here we have specified that the `<title>` element can be a subelement of `<book>`. As we have not put an n-expression in brackets after it, there must be exactly 1 `<title>` element. The `<subtitle>` element we have indicated is optional, meaning that there can be 0 or 1 `<subtitle>` elements, but no more. We have specified that there must be exactly 1 `<isbn>` element.
The use of square brackets here indicates that these elements must appear in this order. So the XML below would be wrong, and would fail validation against the XSD.
```xml
<book id="the_fellowship_of_the_ring">
<isbn>0261103571</isbn>
<title>The Fellowship of the Ring</title>
<subtitle>The Lord of the Rings, Book 1</subtitle>
</book>
```
If we wanted to specify that the order of the subelements does not matter, we would use recurve brackets, as below.
```
element book {
attributes: id;
allowedContent: { title, subtitle (optional), isbn };
}
```
Putting everything together, we get
```
root element books {
allowedContent: [ book (n >= 0) ];
}
dataType _id {
baseType: string;
allowedPattern: '[A-Za-z0-9_]+';
}
attribute id {
valueType: _id;
}
element book {
attributes: id;
allowedContent: [ title, subtitle (optional), isbn ];
}
element title {
allowedContent: *any text*;
}
element subtitle {
allowedContent: *any text*;
}
element isbn {
allowedContent: *any text*;
}
```
This schema, when put through the Schemata code, produces the following XSD file.
```xml
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xs:simpleType name="__type__d___id">
<xs:restriction base="xs:string">
<xs:pattern value="[A-Za-z0-9_]+"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="__type__e__books" mixed="false">
<xs:sequence>
<xs:element name="book" type="__type__e__book" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="__type__e__book" mixed="false">
<xs:sequence>
<xs:element name="title" type="__type__e__title"/>
<xs:element name="subtitle" type="__type__e__subtitle" minOccurs="0"/>
<xs:element name="isbn" type="__type__e__isbn"/>
</xs:sequence>
<xs:attribute name="id" type="__type__d___id" use="required"/>
</xs:complexType>
<xs:simpleType name="__type__e__title">
<xs:restriction base="xs:string"/>
</xs:simpleType>
<xs:simpleType name="__type__e__subtitle">
<xs:restriction base="xs:string"/>
</xs:simpleType>
<xs:simpleType name="__type__e__isbn">
<xs:restriction base="xs:string"/>
</xs:simpleType>
<xs:element name="books" type="__type__e__books"/>
</xs:schema>
```
The XML file we started with passes validation against this XSD file.
There are many features which have not been covered in this introduction.
## Principles of Design
The ease-of-reading and intuitiveness of the Schemata syntax should be apparent. The syntax is superficially similar to that of CSS, which many developers are familiar with. Much of the 'heavy-lifting' of the mark-up is done by brackets, colons, and semi-colons, as opposed to opening and closing XML tags.
Schemata is based around the concept of **structures**. XML schemas can be defined in terms of element, attribute, and data structures. JSON schemas can be defined in terms of object, property, array, and data structures. Really, any collection of data can be described in terms of the structures that make it up.
Thinking in these terms, we can see that a Schemata file is ultimately just a list of structures. The structures can refer to each other and include each other, but the file is ultimately just a one-dimensional list.
## Credits
Made by B. T. Milnes for Nagwa Limited
|
schematacode
|
/schematacode-1.0.1.tar.gz/schematacode-1.0.1/README.md
|
README.md
|
<?xml version="1.0" encoding="utf-8" ?>
<books>
<book id="the_fellowship_of_the_ring">
<title>The Fellowship of the Ring</title>
<subtitle>The Lord of the Rings, Book 1</subtitle>
<isbn>0261103571</isbn>
</book>
<book id="pride_and_prejudice">
<title>Pride and Prejudice</title>
<subtitle></subtitle>
<isbn>9780141040349</isbn>
</book>
<book id="a_game_of_thrones">
<title>A Game of Thrones</title>
<subtitle>A Song of Ice and Fire, Book 1</subtitle>
<isbn>9780006479888</isbn>
</book>
</books>
root element books {
}
root element my_root_element {
tagName: 'books';
}
attribute id {
valueType: string;
}
element book {
attributes: id;
}
root element books {
allowedContent: [ book (n >= 0) ];
}
root element books {
allowedContent: [ book (n >= 0) ];
}
attribute id {
valueType: string;
}
element book {
attributes: id;
}
dataType _id {
baseType: string;
allowedPattern: '[A-Za-z0-9_]+';
}
root element books {
allowedContent: [ book (n >= 0) ];
}
dataType _id {
baseType: string;
allowedPattern: '[A-Za-z0-9_]+';
}
attribute id {
valueType: _id;
}
element book {
attributes: id;
}
element title {
allowedContent: *any text*;
}
element subtitle {
allowedContent: *any text*;
}
element isbn {
allowedContent: *any text*;
}
element book {
attributes: id;
allowedContent: [ title, subtitle (optional), isbn ];
}
<book id="the_fellowship_of_the_ring">
<isbn>0261103571</isbn>
<title>The Fellowship of the Ring</title>
<subtitle>The Lord of the Rings, Book 1</subtitle>
</book>
element book {
attributes: id;
allowedContent: { title, subtitle (optional), isbn };
}
root element books {
allowedContent: [ book (n >= 0) ];
}
dataType _id {
baseType: string;
allowedPattern: '[A-Za-z0-9_]+';
}
attribute id {
valueType: _id;
}
element book {
attributes: id;
allowedContent: [ title, subtitle (optional), isbn ];
}
element title {
allowedContent: *any text*;
}
element subtitle {
allowedContent: *any text*;
}
element isbn {
allowedContent: *any text*;
}
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xs:simpleType name="__type__d___id">
<xs:restriction base="xs:string">
<xs:pattern value="[A-Za-z0-9_]+"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="__type__e__books" mixed="false">
<xs:sequence>
<xs:element name="book" type="__type__e__book" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="__type__e__book" mixed="false">
<xs:sequence>
<xs:element name="title" type="__type__e__title"/>
<xs:element name="subtitle" type="__type__e__subtitle" minOccurs="0"/>
<xs:element name="isbn" type="__type__e__isbn"/>
</xs:sequence>
<xs:attribute name="id" type="__type__d___id" use="required"/>
</xs:complexType>
<xs:simpleType name="__type__e__title">
<xs:restriction base="xs:string"/>
</xs:simpleType>
<xs:simpleType name="__type__e__subtitle">
<xs:restriction base="xs:string"/>
</xs:simpleType>
<xs:simpleType name="__type__e__isbn">
<xs:restriction base="xs:string"/>
</xs:simpleType>
<xs:element name="books" type="__type__e__books"/>
</xs:schema>
| 0.254046 | 0.938745 |
import os
import logging
import re
from lxml.etree import ElementTree as XMLElementTree, Element as XMLElement, SubElement as XMLSubelement, Comment as XMLComment, QName, indent
import json
from schemata.structures import *
logger = logging.getLogger("schemata.exporters")
class JSONSchemasExporter(object):
"""
This class takes a Schemata schema and exports it into the JSON Schemas format.
To do:
This class does not implement *every* feature of JSON Schemas yet, as it has been developed for a very specific use-case.
...
Attributes
----------
_js : string
The JSON Schemas specification being used. This is the value of the $schema property. Do not change.
"""
def __init__(self):
self._js = "https://json-schema.org/draft/2020-12/schema"
def exportSchema(self, schema, versionNumber, schemaURI, filePath = ""):
"""
Constructs the root JSON object for a JSON Schemas export of the given schema, and saves it to the given file path.
Parameters
----------
schema : Schema
The schema to export.
versionNumber : string
The version number of this schema. Can follow any convention you like.
schemaURI : string
A URI to this schema.
filePath : string
The path to which to save the output. Use an empty string to indicate that the output should not be saved as a file.
Returns
-------
The JSON object.
"""
logging.debug("Exporting schema for {} as JSON Schema.".format(schema.formatName))
o1 = {}
o1["$schema"] = self._js
o1["$id"] = schemaURI
o1["title"] = "{} ({})".format(schema.formatName, versionNumber)
o1["type"] = "object"
rootObject = schema.getRootObjectStructures()[0]
self._exportObject(schema, rootObject, o1)
if filePath != "":
with open(filePath, "w") as fo:
json.dump(o1, fo, indent=4)
return o1
def _exportArray(self, schema, _array, jsonObject):
"""
Internal function. Exports an array structure to the JSON Schemas format.
Parameters
----------
schema : Schema
The schema being exported.
_array : ArrayStructure
The array structure being exported.
jsonObject : dictionary
The dictionary / JSON object to which to attach this array.
Returns
-------
None
"""
logger.debug("Exporting array structure {}.".format(_array.reference))
jsonObject["type"] = "array"
if _array.itemTypeReference == "string":
jsonObject["items"] = {"type": "string"}
elif _array.itemTypeReference == "integer":
jsonObject["items"] = {"type": "integer"}
elif _array.itemTypeReference == "decimal":
jsonObject["items"] = {"type": "decimal"}
elif _array.itemTypeReference == "boolean":
jsonObject["items"] = {"type": "boolean"}
elif isinstance(_array.itemType, DataStructure):
ds = _array.itemType
if ds.baseStructureReference == "string":
jsonObject["items"] = {}
jsonObject["items"]["type"] = "string"
if ds.allowedPattern != "":
jsonObject["items"]["pattern"] = ds.allowedPattern
if ds.allowedValues != []:
jsonObject["items"]["enum"] = ds.allowedValues
def _exportObject(self, schema, _object, jsonObject):
"""
Internal function. Exports an object structure to the JSON Schemas format.
Parameters
----------
schema : Schema
The schema being exported.
_object : ObjectStructure
The object structure being exported.
jsonObject : dictionary
The dictionary / JSON object to which to attach this array.
Returns
-------
None
"""
logger.debug("Exporting object structure {}.".format(_object.reference))
jsonObject["type"] = "object"
jsonObject["properties"] = {}
jsonObject["required"] = []
jsonObject["additionalProperties"] = False
for _property in _object.properties:
p = _property.propertyStructure
pn = p.propertyName
jsonObject["properties"][pn] = {}
jsonObject["properties"][pn]["description"] = p.metadata.description
self._exportProperty(schema, p, jsonObject["properties"][pn])
if _property.isOptional == False:
jsonObject["required"].append(pn)
def _exportProperty(self, schema, _property, jsonObject):
"""
Internal function. Exports a property structure to the JSON Schemas format.
Parameters
----------
schema : Schema
The schema being exported.
_property : PropertyStructure
The property structure being exported.
jsonObject : dictionary
The dictionary / JSON object to which to attach this array.
Returns
-------
None
"""
logger.debug("Exporting property structure {}.".format(_property.reference))
if _property.valueTypeReference == "string":
jsonObject["type"] = "string"
elif _property.valueTypeReference == "integer":
jsonObject["type"] = "integer"
elif _property.valueTypeReference == "decimal":
jsonObject["type"] = "number"
elif _property.valueTypeReference == "boolean":
jsonObject["type"] = "boolean"
elif isinstance(_property.valueType, DataStructure):
ds = _property.valueType
if ds.baseStructureReference == "string":
jsonObject["type"] = "string"
if ds.allowedPattern != "":
jsonObject["pattern"] = ds.allowedPattern
if ds.allowedValues != []:
jsonObject["enum"] = ds.allowedValues
elif isinstance(_property.valueType, ArrayStructure):
_as = _property.valueType
self._exportArray(schema, _as, jsonObject)
elif isinstance(_property.valueType, ObjectStructure):
_os = _property.valueType
self._exportObject(schema, _os, jsonObject)
class XSDExporter(object):
"""
A class that takes a Schemata schema and exports it to the XSD format.
...
Attributes
----------
_xs : string
The value of xmlns:xs. Do not change.
_typePrefix : string
XSD allows the definition of reusable types. This exporter takes full advantage of that, as it's an approach that
closely matches how Schemata works, making the export easier. This string is a prefix that's applied to type names
in the XSD, to distinguish them easily from other kinds of elements. You can change this if you want, but there's
not much point. Set to '__type__' by default.
"""
def __init__(self):
self._xs = "http://www.w3.org/2001/XMLSchema"
self._typePrefix = "__type__"
def _getXSDTypeName(self, structure):
if isinstance(structure, DataStructure):
return self._typePrefix + "d__" + structure.reference
if isinstance(structure, ElementStructure):
return self._typePrefix + "e__" + structure.reference
if isinstance(structure, AttributeStructure):
return self._typePrefix + "a__" + structure.reference
raise Exception("Cannot create XSD type name for {}.".format(structure.reference))
def exportSchema(self, schema, versionNumber, filePath = ""):
"""
Exports a schema as XSD, saving it to the given file path.
Parameters
----------
schema : Schema
The schema to export.
versionNumber : string
The version number of the schema.
filePath : string
The path to which to save the XSD file. Use an empty string to indicate that the XSD object should not be saved to a file.
Returns
-------
An ElementTree which is the XSD schema.
"""
xs = self._xs
logging.debug("Exporting schema for {} as XSD.".format(schema.formatName))
e1 = XMLElement(QName(xs, "schema"))
e1.set("elementFormDefault", "qualified")
# Put a comment at the top of the XSD file saying what XML format it's for.
if schema.formatName != "":
c1 = XMLComment(" An XSD file for {} ({}). ".format(schema.formatName, versionNumber))
e1.append(c1)
# First export all of the data structures, as these are more basic, and then export all of the element structures.
self._exportDataStructures(schema, e1)
self._exportElementStructures(schema, e1)
logging.debug("Exporting root elements.")
# The root element structures are exported last. This means that the output XSD file should be 'read' in reverse.
roots = schema.getRootElementStructures()
for root in roots:
logging.debug("Exporting element <{}>.".format(root.elementName))
e2 = XMLElement(QName(xs, "element"))
e2.set("name", root.elementName)
e2.set("type", self._getXSDTypeName(root))
e1.append(e2)
tree = XMLElementTree(e1)
indent(tree, space=" ")
if filePath != "":
tree.write(filePath, xml_declaration=True, encoding="utf-8", pretty_print=True)
return tree
def _exportDataStructures(self, schema, xsdElement):
"""
Exports all of the data structures in the schema.
Parameters
----------
schema : Schema
The schema being exported.
xsdElement : Element
The XML element to which to attach these data structures.
Returns
-------
None
"""
xs = self._xs
logging.debug("Exporting data structures.")
dataStructures = schema.getDataStructures()
for dataStructure in dataStructures:
# If a data structure isn't actually used in the schema, don't export it.
if not dataStructure.isUsed:
continue
logging.debug("Exporting data structure '{}'.".format(dataStructure.reference))
e1 = XMLElement(QName(xs, "simpleType"))
e1.set("name", self._getXSDTypeName(dataStructure))
if dataStructure.baseStructureReference == "string":
logging.debug(f"'{dataStructure.reference}' has an XSD base of string.")
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:string")
if dataStructure.allowedPattern != "":
logging.debug(f"Setting pattern value to '{dataStructure.allowedPattern}'")
e3 = XMLElement(QName(xs, "pattern"))
e3.set("value", dataStructure.allowedPattern)
e2.append(e3)
elif dataStructure.allowedValues:
logging.debug(f"Setting enumeration values.")
for value in dataStructure.allowedValues:
e3 = XMLElement(QName(xs, "enumeration"))
e3.set("value", value)
e2.append(e3)
e1.append(e2)
elif dataStructure.baseStructureReference == "decimal":
logging.debug(f"'{dataStructure.reference}' has an XSD base of decimal.")
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:decimal")
e1.append(e2)
elif dataStructure.baseStructureReference == "integer":
logging.debug(f"'{dataStructure.reference}' has an XSD base of integer.")
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:integer")
if dataStructure.minimumValue != None:
logging.debug(f"Setting minInclusive value.")
e3 = XMLElement(QName(xs, "minInclusive"))
e3.set("value", str(dataStructure.minimumValue))
e2.append(e3)
if dataStructure.maximumValue != None:
logging.debug(f"Setting maxInclusive value.")
e3 = XMLElement(QName(xs, "maxInclusive"))
e3.set("value", str(dataStructure.maximumValue))
e2.append(e3)
e1.append(e2)
elif dataStructure.baseStructureReference == "boolean":
logging.debug(f"'{dataStructure.reference}' has an XSD base of boolean.")
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:boolean")
e1.append(e2)
xsdElement.append(e1)
logging.debug("Exported data structure '{}'.".format(dataStructure.reference))
logging.debug("Exported data structures.")
def _exportElementStructures(self, schema, xsdElement):
"""
Exports all of the element structures in the schema.
Parameters
----------
schema : Schema
The schema being exported.
xsdElement : Element
The XML element to which to attach these element structures.
Returns
-------
None
"""
xs = self._xs
logging.debug("Exporting element structures.")
elementStructures = schema.getElementStructures()
for elementStructure in elementStructures:
# If the element structure isn't actually used in the schema (i.e., it isn't defined as a possible root element or subelement of another element), don't export it.
if not elementStructure.isUsed:
continue
logging.debug("Exporting element structure '{}' <{}>.".format(elementStructure.reference, elementStructure.elementName))
# Here we decide whether the element is a 'simpleType' element or a 'complexType' element - it's quite an unintuitive distinction.
if not elementStructure.hasContent:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
self._exportAttributes(schema, elementStructure.attributes, e1)
xsdElement.append(e1)
elif elementStructure.contentIsElementsOnly:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e1.set("mixed", "false")
self._exportSubelements(schema, elementStructure.allowedContent, e1)
self._exportAttributes(schema, elementStructure.attributes, e1)
xsdElement.append(e1)
elif elementStructure.contentIsElementsAndAnyText:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e1.set("mixed", "true")
self._exportSubelements(schema, elementStructure.allowedContent, e1)
self._exportAttributes(schema, elementStructure.attributes, e1)
xsdElement.append(e1)
elif elementStructure.contentIsAnyText and elementStructure.hasAttributes:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e2 = XMLElement(QName(xs, "simpleContent"))
e3 = XMLElement(QName(xs, "extension"))
e3.set("base", "xs:string")
self._exportAttributes(schema, elementStructure.attributes, e3)
e2.append(e3)
e1.append(e2)
xsdElement.append(e1)
elif elementStructure.contentIsAnyText and not elementStructure.hasAttributes:
e1 = XMLElement(QName(xs, "simpleType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:string")
e1.append(e2)
xsdElement.append(e1)
elif elementStructure.contentIsSingleValue and elementStructure.hasAttributes:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e2 = XMLElement(QName(xs, "simpleContent"))
e3 = XMLElement(QName(xs, "extension"))
if elementStructure.valueTypeReference == "decimal":
e3.set("base", "xs:decimal")
elif elementStructure.valueTypeReference == "integer":
e3.set("base", "xs:integer")
elif elementStructure.valueTypeReference == "boolean":
e3.set("base", "xs:boolean")
else:
e3.set("base", self._getXSDTypeName(elementStructure.valueType))
self._exportAttributes(schema, elementStructure.attributes, e3)
e2.append(e3)
e1.append(e2)
xsdElement.append(e1)
elif elementStructure.contentIsSingleValue and not elementStructure.hasAttributes:
e1 = XMLElement(QName(xs, "simpleType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e2 = XMLElement(QName(xs, "restriction"))
if elementStructure.valueTypeReference == "decimal":
e2.set("base", "xs:decimal")
if elementStructure.valueTypeReference == "integer":
e2.set("base", "xs:integer")
elif elementStructure.valueTypeReference == "boolean":
e2.set("base", "xs:boolean")
else:
e2.set("base", self._getXSDTypeName(elementStructure.valueType))
e1.append(e2)
xsdElement.append(e1)
else:
logging.warn("Could not export element structure '{}' <{}>.".format(elementStructure.reference, elementStructure.elementName))
def _exportSubelements(self, schema, elements, xsdElement):
"""
Exports a structure list to XSD.
Parameters
----------
schema : Schema
The schema being exported.
elements : StructureList
The structure list being exported (representing the subelements of an element).
xsdElement : Element
The XML element to which to attach this list.
Returns
-------
None
"""
xs = self._xs
xsdIndicatorType = "sequence"
# Schemata uses a bit more natural language when it comes to lists of elements than XSD does.
# Here we have to translate from the language of Schemata to the language of XSD.
# OrderedStructureList correlates clearly to an XSD sequence.
# StructureChoice correlates clearly to an XSD choice.
# UnorderedStructureList can be represented by an XSD choice that can be used any number of times. (This is not perfect.)
# This here is one of the reasons why Schemata is nicer to use than XSD - this is a pain to do by hand in XSD.
if isinstance(elements, OrderedStructureList):
e1 = XMLElement(QName(xs, "sequence"))
if isinstance(elements, UnorderedStructureList):
xsdIndicatorType = "choice"
e1 = XMLElement(QName(xs, "choice"))
e1.set("minOccurs", "0")
e1.set("maxOccurs", "unbounded")
if isinstance(elements, StructureChoice):
xsdIndicatorType = "choice"
e1 = XMLElement(QName(xs, "choice"))
if elements == None:
return
for element in elements.structures:
if isinstance(element, OrderedStructureList) or isinstance(element, UnorderedStructureList) or isinstance(element, StructureChoice):
self._exportSubelements(schema, element, e1)
else:
if isinstance(element, AnyTextUsageReference):
continue
logging.debug(f"Exporting element of type {type(element)}.")
logging.debug(f"Exporting {self._getXSDTypeName(element.elementStructure)}.")
e3 = XMLElement(QName(xs, "element"))
e3.set("name", element.elementStructure.elementName)
e3.set("type", self._getXSDTypeName(element.elementStructure))
p = element.minimumNumberOfOccurrences
q = element.maximumNumberOfOccurrences
if xsdIndicatorType == "sequence":
if p != 1:
e3.set("minOccurs", str(p))
if q != 1:
e3.set("maxOccurs", "unbounded" if q == -1 else str(q))
e1.append(e3)
xsdElement.append(e1)
def _exportAttributes(self, schema, attributes, xsdElement):
"""
Exports the given attribute structures to XSD.
Parameters
----------
schema : Schema
The schema being exported.
attributes : list of AttributeStructure
The attribute structures being exported.
xsdElement : Element
The XML element to which to attach these attribute structures.
Returns
-------
None
"""
xs = self._xs
baseTypes = ["string", "integer", "boolean"]
for attribute in attributes:
a = attribute.attributeStructure
e1 = XMLElement(QName(xs, "attribute"))
e1.set("name", a.attributeName)
if a.dataStructureReference in baseTypes:
if a.dataStructureReference == "string":
e1.set("type", "xs:string")
if a.dataStructureReference == "integer":
e1.set("type", "xs:integer")
if a.dataStructureReference == "boolean":
e1.set("type", "xs:boolean")
else:
e1.set("type", self._getXSDTypeName(a.dataStructure))
e1.set("use", "optional" if attribute.isOptional else "required")
xsdElement.append(e1)
class SpecificationGenerator(object):
"""
A class for generating specifications / human-readable documentation from Schemata schemas. The generated documents are in Markdown. The generation is not perfect, but it
makes the process of writing a specification / human-readable documentation a lot quicker.
To do:
This only works for XML schemas at the moment - need to extend it to JSON schemas.
Would be nice to be able to generate documentation in HTML as well as Markdown.
"""
def __init__(self):
pass
def generateSpecification(self, schema, filePath):
with open(filePath, "w") as fileObject:
rootElements = schema.getPossibleRootElementStructures()
nonRootElements = schema.getNonRootElementStructures()
elements = rootElements + nonRootElements
fileObject.write("# {} Specification\n\n".format(schema.formatName))
fileObject.write("This document gives the specification for {}.\n\n".format(schema.formatName))
fileObject.write("## Table of Contents\n\n")
for element in elements:
fileObject.write("- [The <{}> element](#the-{}-element)\n".format(element.elementName, re.sub("_", "-", element.elementName)))
for element in elements:
fileObject.write("\n\n<br /><br />\n\n")
fileObject.write("## The <{}> element\n\n".format(element.elementName))
fileObject.write("{}\n\n".format(element.description.replace("<", "<").replace(">", ">")))
fileObject.write("### Attributes\n\n")
aa = []
if element.attributes:
fileObject.write("| Name | Required | Allowed Values | Description |\n")
fileObject.write("|---|---|---|---|\n")
for attribute in element.attributes:
a = schema.getAttributeStructureByReference(attribute.attributeReference)
d = schema.getDataStructureByReference(a.dataStructure)
aa.append(a)
allowedValuesText = d.description
if d.allowedValues and d.description == "":
allowedValuesText = "one of: {}".format(", ".join(["`{}`".format(v) for v in d.allowedValues]))
elif d.allowedPattern and d.description == "" and d.baseStructure == "string":
allowedValuesText = f"a string with the pattern `{d.allowedPattern}`"
fileObject.write("| `{}` | {} | {} | {} |\n".format(a.attributeName, "Required" if not attribute.isOptional else "Optional", allowedValuesText, a.description))
fileObject.write("\n")
else:
fileObject.write("None\n\n")
fileObject.write("### Possible Subelements\n\n")
ee = []
if element.subelements:
for subelement in element.subelements.elements:
e = schema.getElementStructureByReference(subelement.elementReference)
ee.append(e)
fileObject.write("- <{}>\n".format(e.elementName))
fileObject.write("\n")
else:
fileObject.write("None\n\n")
fileObject.write("### Examples\n\n")
fileObject.write("Below is shown an example of the `<{}>` element.\n\n".format(element.elementName))
fileObject.write("```xml\n")
attributeString = " ".join(["{}=\"{}\"".format(a.attributeName, "..." if a.exampleValue == "" else a.exampleValue) for a in aa])
if element.isSelfClosing == False:
if aa:
fileObject.write("<{} {}>\n".format(element.elementName, attributeString))
else:
fileObject.write("<{}>\n".format(element.elementName))
if element.allowedContent == "text only":
fileObject.write(" {}\n".format(element.exampleValue))
else:
for e in ee:
if e.isSelfClosing == False:
fileObject.write(" <{}></{}>\n".format(e.elementName, e.elementName))
else:
fileObject.write(" <{} />\n".format(e.elementName, e.elementName))
fileObject.write("</{}>\n".format(element.elementName))
else:
if aa:
fileObject.write("<{} {} />\n".format(element.elementName, attributeString))
else:
fileObject.write("<{} />\n".format(element.elementName))
fileObject.write("```\n\n")
class ExampleFileGenerator(object):
"""
A class for generating example files that conform to a given schema.
...
To do:
At the moment this only works for XML schemas - would be nice to get this working for JSON schemas too.
Would be nice to get this generating invalid XML files too, for automatic testing of schemas.
"""
def __init__(self):
pass
def generateExampleFiles(self, schema, folderPath):
os.makedirs(folderPath, exist_ok=True)
rootElements = schema.getRootElementStructures()
for rootElement in rootElements:
filePath = os.path.join(folderPath, "example1.xml")
e1 = XMLElement(rootElement.elementName)
self._generateAttributes(rootElement, e1)
self._generateSubelements(rootElement, e1)
tree = XMLElementTree(e1)
indent(tree, space=" ")
tree.write(filePath, xml_declaration=True, encoding="utf-8", pretty_print=True)
def _generateAttributes(self, elementStructure, e1):
for attributeUsageReference in elementStructure.attributes:
s = attributeUsageReference.attributeStructure
logger.debug(f"Generating attribute '{s.attributeName}'.")
if s.dataStructure != None:
e1.set(s.attributeName, s.dataStructure.metadata.exampleValue)
def _generateSubelements(self, elementStructure, e1):
if elementStructure.contentIsSingleValue:
if elementStructure.valueType != None:
e1.text = elementStructure.valueType.metadata.exampleValue
elif elementStructure.metadata.exampleValue != "":
e1.text = elementStructure.metadata.exampleValue
if elementStructure.contentIsAnyText:
e1.text = elementStructure.metadata.exampleValue
if isinstance(elementStructure.allowedContent, OrderedStructureList):
for structure in elementStructure.allowedContent.structures:
if isinstance(structure, ElementUsageReference):
n = 1
if structure.maximumNumberOfOccurrences == -1:
n = 3
elif structure.maximumNumberOfOccurrences <= 3:
n = structure.maximumNumberOfOccurrences
for x in range(n):
e2 = XMLElement(structure.elementStructure.elementName)
self._generateAttributes(structure.elementStructure, e2)
self._generateSubelements(structure.elementStructure, e2)
e1.append(e2)
"""
Functions that allow you to do the export process in a single line.
Best not to use these if you're going to export a large number of schemas.
"""
def exportSchemaAsXSD(schema, versionNumber, filePath):
"""
Exports the given schema as an XSD document.
Parameters
----------
schema : Schema
The schema to export.
versionNumber : string
The version number of the schema.
filePath : string
The path to which to save the XSD file.
Returns
-------
None
"""
xsdExporter = XSDExporter()
xsdExporter.exportSchema(schema, versionNumber, filePath)
def exportSchemaAsJSONSchema(schema, versionNumber, filePath):
"""
Exports the given schema as a JSON Schemas document.
Parameters
----------
schema : Schema
The schema to export.
versionNumber : string
The version number of the schema.
filePath : string
The path to which to save the JSON Schemas file.
Returns
-------
None
"""
jsonSchemasExporter = JSONSchemasExporter()
jsonSchemasExporter.exportSchema(schema, versionNumber, filePath)
def generateSpecification(schema, filePath):
"""
Generates a specification / human-readable documentation for the given schema. Some manual editing will be required,
but this function can save a lot of time.
Parameters
----------
schema : Schema
The schema to create a specification for.
filePath : string
The file path to which to save the specification.
Returns
-------
None
"""
specificationGenerator = SpecificationGenerator()
specificationGenerator.generateSpecification(schema, filePath)
def generateExampleXMLFiles(schema, folderPath):
"""
Generates example XML files for the given schema. Some manual editing will be required, but this function
can save time at the start of defining a new format.
Parameters
----------
schema : Schema
The schema to create example files for.
folderPath : string
The folder to which to save the example files.
Returns
-------
None
"""
exampleFileGenerator = ExampleFileGenerator()
exampleFileGenerator.generateExampleFiles(schema, folderPath)
|
schematacode
|
/schematacode-1.0.1.tar.gz/schematacode-1.0.1/schemata/exporters.py
|
exporters.py
|
import os
import logging
import re
from lxml.etree import ElementTree as XMLElementTree, Element as XMLElement, SubElement as XMLSubelement, Comment as XMLComment, QName, indent
import json
from schemata.structures import *
logger = logging.getLogger("schemata.exporters")
class JSONSchemasExporter(object):
"""
This class takes a Schemata schema and exports it into the JSON Schemas format.
To do:
This class does not implement *every* feature of JSON Schemas yet, as it has been developed for a very specific use-case.
...
Attributes
----------
_js : string
The JSON Schemas specification being used. This is the value of the $schema property. Do not change.
"""
def __init__(self):
self._js = "https://json-schema.org/draft/2020-12/schema"
def exportSchema(self, schema, versionNumber, schemaURI, filePath = ""):
"""
Constructs the root JSON object for a JSON Schemas export of the given schema, and saves it to the given file path.
Parameters
----------
schema : Schema
The schema to export.
versionNumber : string
The version number of this schema. Can follow any convention you like.
schemaURI : string
A URI to this schema.
filePath : string
The path to which to save the output. Use an empty string to indicate that the output should not be saved as a file.
Returns
-------
The JSON object.
"""
logging.debug("Exporting schema for {} as JSON Schema.".format(schema.formatName))
o1 = {}
o1["$schema"] = self._js
o1["$id"] = schemaURI
o1["title"] = "{} ({})".format(schema.formatName, versionNumber)
o1["type"] = "object"
rootObject = schema.getRootObjectStructures()[0]
self._exportObject(schema, rootObject, o1)
if filePath != "":
with open(filePath, "w") as fo:
json.dump(o1, fo, indent=4)
return o1
def _exportArray(self, schema, _array, jsonObject):
"""
Internal function. Exports an array structure to the JSON Schemas format.
Parameters
----------
schema : Schema
The schema being exported.
_array : ArrayStructure
The array structure being exported.
jsonObject : dictionary
The dictionary / JSON object to which to attach this array.
Returns
-------
None
"""
logger.debug("Exporting array structure {}.".format(_array.reference))
jsonObject["type"] = "array"
if _array.itemTypeReference == "string":
jsonObject["items"] = {"type": "string"}
elif _array.itemTypeReference == "integer":
jsonObject["items"] = {"type": "integer"}
elif _array.itemTypeReference == "decimal":
jsonObject["items"] = {"type": "decimal"}
elif _array.itemTypeReference == "boolean":
jsonObject["items"] = {"type": "boolean"}
elif isinstance(_array.itemType, DataStructure):
ds = _array.itemType
if ds.baseStructureReference == "string":
jsonObject["items"] = {}
jsonObject["items"]["type"] = "string"
if ds.allowedPattern != "":
jsonObject["items"]["pattern"] = ds.allowedPattern
if ds.allowedValues != []:
jsonObject["items"]["enum"] = ds.allowedValues
def _exportObject(self, schema, _object, jsonObject):
"""
Internal function. Exports an object structure to the JSON Schemas format.
Parameters
----------
schema : Schema
The schema being exported.
_object : ObjectStructure
The object structure being exported.
jsonObject : dictionary
The dictionary / JSON object to which to attach this array.
Returns
-------
None
"""
logger.debug("Exporting object structure {}.".format(_object.reference))
jsonObject["type"] = "object"
jsonObject["properties"] = {}
jsonObject["required"] = []
jsonObject["additionalProperties"] = False
for _property in _object.properties:
p = _property.propertyStructure
pn = p.propertyName
jsonObject["properties"][pn] = {}
jsonObject["properties"][pn]["description"] = p.metadata.description
self._exportProperty(schema, p, jsonObject["properties"][pn])
if _property.isOptional == False:
jsonObject["required"].append(pn)
def _exportProperty(self, schema, _property, jsonObject):
"""
Internal function. Exports a property structure to the JSON Schemas format.
Parameters
----------
schema : Schema
The schema being exported.
_property : PropertyStructure
The property structure being exported.
jsonObject : dictionary
The dictionary / JSON object to which to attach this array.
Returns
-------
None
"""
logger.debug("Exporting property structure {}.".format(_property.reference))
if _property.valueTypeReference == "string":
jsonObject["type"] = "string"
elif _property.valueTypeReference == "integer":
jsonObject["type"] = "integer"
elif _property.valueTypeReference == "decimal":
jsonObject["type"] = "number"
elif _property.valueTypeReference == "boolean":
jsonObject["type"] = "boolean"
elif isinstance(_property.valueType, DataStructure):
ds = _property.valueType
if ds.baseStructureReference == "string":
jsonObject["type"] = "string"
if ds.allowedPattern != "":
jsonObject["pattern"] = ds.allowedPattern
if ds.allowedValues != []:
jsonObject["enum"] = ds.allowedValues
elif isinstance(_property.valueType, ArrayStructure):
_as = _property.valueType
self._exportArray(schema, _as, jsonObject)
elif isinstance(_property.valueType, ObjectStructure):
_os = _property.valueType
self._exportObject(schema, _os, jsonObject)
class XSDExporter(object):
"""
A class that takes a Schemata schema and exports it to the XSD format.
...
Attributes
----------
_xs : string
The value of xmlns:xs. Do not change.
_typePrefix : string
XSD allows the definition of reusable types. This exporter takes full advantage of that, as it's an approach that
closely matches how Schemata works, making the export easier. This string is a prefix that's applied to type names
in the XSD, to distinguish them easily from other kinds of elements. You can change this if you want, but there's
not much point. Set to '__type__' by default.
"""
def __init__(self):
self._xs = "http://www.w3.org/2001/XMLSchema"
self._typePrefix = "__type__"
def _getXSDTypeName(self, structure):
if isinstance(structure, DataStructure):
return self._typePrefix + "d__" + structure.reference
if isinstance(structure, ElementStructure):
return self._typePrefix + "e__" + structure.reference
if isinstance(structure, AttributeStructure):
return self._typePrefix + "a__" + structure.reference
raise Exception("Cannot create XSD type name for {}.".format(structure.reference))
def exportSchema(self, schema, versionNumber, filePath = ""):
"""
Exports a schema as XSD, saving it to the given file path.
Parameters
----------
schema : Schema
The schema to export.
versionNumber : string
The version number of the schema.
filePath : string
The path to which to save the XSD file. Use an empty string to indicate that the XSD object should not be saved to a file.
Returns
-------
An ElementTree which is the XSD schema.
"""
xs = self._xs
logging.debug("Exporting schema for {} as XSD.".format(schema.formatName))
e1 = XMLElement(QName(xs, "schema"))
e1.set("elementFormDefault", "qualified")
# Put a comment at the top of the XSD file saying what XML format it's for.
if schema.formatName != "":
c1 = XMLComment(" An XSD file for {} ({}). ".format(schema.formatName, versionNumber))
e1.append(c1)
# First export all of the data structures, as these are more basic, and then export all of the element structures.
self._exportDataStructures(schema, e1)
self._exportElementStructures(schema, e1)
logging.debug("Exporting root elements.")
# The root element structures are exported last. This means that the output XSD file should be 'read' in reverse.
roots = schema.getRootElementStructures()
for root in roots:
logging.debug("Exporting element <{}>.".format(root.elementName))
e2 = XMLElement(QName(xs, "element"))
e2.set("name", root.elementName)
e2.set("type", self._getXSDTypeName(root))
e1.append(e2)
tree = XMLElementTree(e1)
indent(tree, space=" ")
if filePath != "":
tree.write(filePath, xml_declaration=True, encoding="utf-8", pretty_print=True)
return tree
def _exportDataStructures(self, schema, xsdElement):
"""
Exports all of the data structures in the schema.
Parameters
----------
schema : Schema
The schema being exported.
xsdElement : Element
The XML element to which to attach these data structures.
Returns
-------
None
"""
xs = self._xs
logging.debug("Exporting data structures.")
dataStructures = schema.getDataStructures()
for dataStructure in dataStructures:
# If a data structure isn't actually used in the schema, don't export it.
if not dataStructure.isUsed:
continue
logging.debug("Exporting data structure '{}'.".format(dataStructure.reference))
e1 = XMLElement(QName(xs, "simpleType"))
e1.set("name", self._getXSDTypeName(dataStructure))
if dataStructure.baseStructureReference == "string":
logging.debug(f"'{dataStructure.reference}' has an XSD base of string.")
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:string")
if dataStructure.allowedPattern != "":
logging.debug(f"Setting pattern value to '{dataStructure.allowedPattern}'")
e3 = XMLElement(QName(xs, "pattern"))
e3.set("value", dataStructure.allowedPattern)
e2.append(e3)
elif dataStructure.allowedValues:
logging.debug(f"Setting enumeration values.")
for value in dataStructure.allowedValues:
e3 = XMLElement(QName(xs, "enumeration"))
e3.set("value", value)
e2.append(e3)
e1.append(e2)
elif dataStructure.baseStructureReference == "decimal":
logging.debug(f"'{dataStructure.reference}' has an XSD base of decimal.")
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:decimal")
e1.append(e2)
elif dataStructure.baseStructureReference == "integer":
logging.debug(f"'{dataStructure.reference}' has an XSD base of integer.")
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:integer")
if dataStructure.minimumValue != None:
logging.debug(f"Setting minInclusive value.")
e3 = XMLElement(QName(xs, "minInclusive"))
e3.set("value", str(dataStructure.minimumValue))
e2.append(e3)
if dataStructure.maximumValue != None:
logging.debug(f"Setting maxInclusive value.")
e3 = XMLElement(QName(xs, "maxInclusive"))
e3.set("value", str(dataStructure.maximumValue))
e2.append(e3)
e1.append(e2)
elif dataStructure.baseStructureReference == "boolean":
logging.debug(f"'{dataStructure.reference}' has an XSD base of boolean.")
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:boolean")
e1.append(e2)
xsdElement.append(e1)
logging.debug("Exported data structure '{}'.".format(dataStructure.reference))
logging.debug("Exported data structures.")
def _exportElementStructures(self, schema, xsdElement):
"""
Exports all of the element structures in the schema.
Parameters
----------
schema : Schema
The schema being exported.
xsdElement : Element
The XML element to which to attach these element structures.
Returns
-------
None
"""
xs = self._xs
logging.debug("Exporting element structures.")
elementStructures = schema.getElementStructures()
for elementStructure in elementStructures:
# If the element structure isn't actually used in the schema (i.e., it isn't defined as a possible root element or subelement of another element), don't export it.
if not elementStructure.isUsed:
continue
logging.debug("Exporting element structure '{}' <{}>.".format(elementStructure.reference, elementStructure.elementName))
# Here we decide whether the element is a 'simpleType' element or a 'complexType' element - it's quite an unintuitive distinction.
if not elementStructure.hasContent:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
self._exportAttributes(schema, elementStructure.attributes, e1)
xsdElement.append(e1)
elif elementStructure.contentIsElementsOnly:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e1.set("mixed", "false")
self._exportSubelements(schema, elementStructure.allowedContent, e1)
self._exportAttributes(schema, elementStructure.attributes, e1)
xsdElement.append(e1)
elif elementStructure.contentIsElementsAndAnyText:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e1.set("mixed", "true")
self._exportSubelements(schema, elementStructure.allowedContent, e1)
self._exportAttributes(schema, elementStructure.attributes, e1)
xsdElement.append(e1)
elif elementStructure.contentIsAnyText and elementStructure.hasAttributes:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e2 = XMLElement(QName(xs, "simpleContent"))
e3 = XMLElement(QName(xs, "extension"))
e3.set("base", "xs:string")
self._exportAttributes(schema, elementStructure.attributes, e3)
e2.append(e3)
e1.append(e2)
xsdElement.append(e1)
elif elementStructure.contentIsAnyText and not elementStructure.hasAttributes:
e1 = XMLElement(QName(xs, "simpleType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e2 = XMLElement(QName(xs, "restriction"))
e2.set("base", "xs:string")
e1.append(e2)
xsdElement.append(e1)
elif elementStructure.contentIsSingleValue and elementStructure.hasAttributes:
e1 = XMLElement(QName(xs, "complexType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e2 = XMLElement(QName(xs, "simpleContent"))
e3 = XMLElement(QName(xs, "extension"))
if elementStructure.valueTypeReference == "decimal":
e3.set("base", "xs:decimal")
elif elementStructure.valueTypeReference == "integer":
e3.set("base", "xs:integer")
elif elementStructure.valueTypeReference == "boolean":
e3.set("base", "xs:boolean")
else:
e3.set("base", self._getXSDTypeName(elementStructure.valueType))
self._exportAttributes(schema, elementStructure.attributes, e3)
e2.append(e3)
e1.append(e2)
xsdElement.append(e1)
elif elementStructure.contentIsSingleValue and not elementStructure.hasAttributes:
e1 = XMLElement(QName(xs, "simpleType"))
e1.set("name", self._getXSDTypeName(elementStructure))
e2 = XMLElement(QName(xs, "restriction"))
if elementStructure.valueTypeReference == "decimal":
e2.set("base", "xs:decimal")
if elementStructure.valueTypeReference == "integer":
e2.set("base", "xs:integer")
elif elementStructure.valueTypeReference == "boolean":
e2.set("base", "xs:boolean")
else:
e2.set("base", self._getXSDTypeName(elementStructure.valueType))
e1.append(e2)
xsdElement.append(e1)
else:
logging.warn("Could not export element structure '{}' <{}>.".format(elementStructure.reference, elementStructure.elementName))
def _exportSubelements(self, schema, elements, xsdElement):
"""
Exports a structure list to XSD.
Parameters
----------
schema : Schema
The schema being exported.
elements : StructureList
The structure list being exported (representing the subelements of an element).
xsdElement : Element
The XML element to which to attach this list.
Returns
-------
None
"""
xs = self._xs
xsdIndicatorType = "sequence"
# Schemata uses a bit more natural language when it comes to lists of elements than XSD does.
# Here we have to translate from the language of Schemata to the language of XSD.
# OrderedStructureList correlates clearly to an XSD sequence.
# StructureChoice correlates clearly to an XSD choice.
# UnorderedStructureList can be represented by an XSD choice that can be used any number of times. (This is not perfect.)
# This here is one of the reasons why Schemata is nicer to use than XSD - this is a pain to do by hand in XSD.
if isinstance(elements, OrderedStructureList):
e1 = XMLElement(QName(xs, "sequence"))
if isinstance(elements, UnorderedStructureList):
xsdIndicatorType = "choice"
e1 = XMLElement(QName(xs, "choice"))
e1.set("minOccurs", "0")
e1.set("maxOccurs", "unbounded")
if isinstance(elements, StructureChoice):
xsdIndicatorType = "choice"
e1 = XMLElement(QName(xs, "choice"))
if elements == None:
return
for element in elements.structures:
if isinstance(element, OrderedStructureList) or isinstance(element, UnorderedStructureList) or isinstance(element, StructureChoice):
self._exportSubelements(schema, element, e1)
else:
if isinstance(element, AnyTextUsageReference):
continue
logging.debug(f"Exporting element of type {type(element)}.")
logging.debug(f"Exporting {self._getXSDTypeName(element.elementStructure)}.")
e3 = XMLElement(QName(xs, "element"))
e3.set("name", element.elementStructure.elementName)
e3.set("type", self._getXSDTypeName(element.elementStructure))
p = element.minimumNumberOfOccurrences
q = element.maximumNumberOfOccurrences
if xsdIndicatorType == "sequence":
if p != 1:
e3.set("minOccurs", str(p))
if q != 1:
e3.set("maxOccurs", "unbounded" if q == -1 else str(q))
e1.append(e3)
xsdElement.append(e1)
def _exportAttributes(self, schema, attributes, xsdElement):
"""
Exports the given attribute structures to XSD.
Parameters
----------
schema : Schema
The schema being exported.
attributes : list of AttributeStructure
The attribute structures being exported.
xsdElement : Element
The XML element to which to attach these attribute structures.
Returns
-------
None
"""
xs = self._xs
baseTypes = ["string", "integer", "boolean"]
for attribute in attributes:
a = attribute.attributeStructure
e1 = XMLElement(QName(xs, "attribute"))
e1.set("name", a.attributeName)
if a.dataStructureReference in baseTypes:
if a.dataStructureReference == "string":
e1.set("type", "xs:string")
if a.dataStructureReference == "integer":
e1.set("type", "xs:integer")
if a.dataStructureReference == "boolean":
e1.set("type", "xs:boolean")
else:
e1.set("type", self._getXSDTypeName(a.dataStructure))
e1.set("use", "optional" if attribute.isOptional else "required")
xsdElement.append(e1)
class SpecificationGenerator(object):
"""
A class for generating specifications / human-readable documentation from Schemata schemas. The generated documents are in Markdown. The generation is not perfect, but it
makes the process of writing a specification / human-readable documentation a lot quicker.
To do:
This only works for XML schemas at the moment - need to extend it to JSON schemas.
Would be nice to be able to generate documentation in HTML as well as Markdown.
"""
def __init__(self):
pass
def generateSpecification(self, schema, filePath):
with open(filePath, "w") as fileObject:
rootElements = schema.getPossibleRootElementStructures()
nonRootElements = schema.getNonRootElementStructures()
elements = rootElements + nonRootElements
fileObject.write("# {} Specification\n\n".format(schema.formatName))
fileObject.write("This document gives the specification for {}.\n\n".format(schema.formatName))
fileObject.write("## Table of Contents\n\n")
for element in elements:
fileObject.write("- [The <{}> element](#the-{}-element)\n".format(element.elementName, re.sub("_", "-", element.elementName)))
for element in elements:
fileObject.write("\n\n<br /><br />\n\n")
fileObject.write("## The <{}> element\n\n".format(element.elementName))
fileObject.write("{}\n\n".format(element.description.replace("<", "<").replace(">", ">")))
fileObject.write("### Attributes\n\n")
aa = []
if element.attributes:
fileObject.write("| Name | Required | Allowed Values | Description |\n")
fileObject.write("|---|---|---|---|\n")
for attribute in element.attributes:
a = schema.getAttributeStructureByReference(attribute.attributeReference)
d = schema.getDataStructureByReference(a.dataStructure)
aa.append(a)
allowedValuesText = d.description
if d.allowedValues and d.description == "":
allowedValuesText = "one of: {}".format(", ".join(["`{}`".format(v) for v in d.allowedValues]))
elif d.allowedPattern and d.description == "" and d.baseStructure == "string":
allowedValuesText = f"a string with the pattern `{d.allowedPattern}`"
fileObject.write("| `{}` | {} | {} | {} |\n".format(a.attributeName, "Required" if not attribute.isOptional else "Optional", allowedValuesText, a.description))
fileObject.write("\n")
else:
fileObject.write("None\n\n")
fileObject.write("### Possible Subelements\n\n")
ee = []
if element.subelements:
for subelement in element.subelements.elements:
e = schema.getElementStructureByReference(subelement.elementReference)
ee.append(e)
fileObject.write("- <{}>\n".format(e.elementName))
fileObject.write("\n")
else:
fileObject.write("None\n\n")
fileObject.write("### Examples\n\n")
fileObject.write("Below is shown an example of the `<{}>` element.\n\n".format(element.elementName))
fileObject.write("```xml\n")
attributeString = " ".join(["{}=\"{}\"".format(a.attributeName, "..." if a.exampleValue == "" else a.exampleValue) for a in aa])
if element.isSelfClosing == False:
if aa:
fileObject.write("<{} {}>\n".format(element.elementName, attributeString))
else:
fileObject.write("<{}>\n".format(element.elementName))
if element.allowedContent == "text only":
fileObject.write(" {}\n".format(element.exampleValue))
else:
for e in ee:
if e.isSelfClosing == False:
fileObject.write(" <{}></{}>\n".format(e.elementName, e.elementName))
else:
fileObject.write(" <{} />\n".format(e.elementName, e.elementName))
fileObject.write("</{}>\n".format(element.elementName))
else:
if aa:
fileObject.write("<{} {} />\n".format(element.elementName, attributeString))
else:
fileObject.write("<{} />\n".format(element.elementName))
fileObject.write("```\n\n")
class ExampleFileGenerator(object):
"""
A class for generating example files that conform to a given schema.
...
To do:
At the moment this only works for XML schemas - would be nice to get this working for JSON schemas too.
Would be nice to get this generating invalid XML files too, for automatic testing of schemas.
"""
def __init__(self):
pass
def generateExampleFiles(self, schema, folderPath):
os.makedirs(folderPath, exist_ok=True)
rootElements = schema.getRootElementStructures()
for rootElement in rootElements:
filePath = os.path.join(folderPath, "example1.xml")
e1 = XMLElement(rootElement.elementName)
self._generateAttributes(rootElement, e1)
self._generateSubelements(rootElement, e1)
tree = XMLElementTree(e1)
indent(tree, space=" ")
tree.write(filePath, xml_declaration=True, encoding="utf-8", pretty_print=True)
def _generateAttributes(self, elementStructure, e1):
for attributeUsageReference in elementStructure.attributes:
s = attributeUsageReference.attributeStructure
logger.debug(f"Generating attribute '{s.attributeName}'.")
if s.dataStructure != None:
e1.set(s.attributeName, s.dataStructure.metadata.exampleValue)
def _generateSubelements(self, elementStructure, e1):
if elementStructure.contentIsSingleValue:
if elementStructure.valueType != None:
e1.text = elementStructure.valueType.metadata.exampleValue
elif elementStructure.metadata.exampleValue != "":
e1.text = elementStructure.metadata.exampleValue
if elementStructure.contentIsAnyText:
e1.text = elementStructure.metadata.exampleValue
if isinstance(elementStructure.allowedContent, OrderedStructureList):
for structure in elementStructure.allowedContent.structures:
if isinstance(structure, ElementUsageReference):
n = 1
if structure.maximumNumberOfOccurrences == -1:
n = 3
elif structure.maximumNumberOfOccurrences <= 3:
n = structure.maximumNumberOfOccurrences
for x in range(n):
e2 = XMLElement(structure.elementStructure.elementName)
self._generateAttributes(structure.elementStructure, e2)
self._generateSubelements(structure.elementStructure, e2)
e1.append(e2)
"""
Functions that allow you to do the export process in a single line.
Best not to use these if you're going to export a large number of schemas.
"""
def exportSchemaAsXSD(schema, versionNumber, filePath):
"""
Exports the given schema as an XSD document.
Parameters
----------
schema : Schema
The schema to export.
versionNumber : string
The version number of the schema.
filePath : string
The path to which to save the XSD file.
Returns
-------
None
"""
xsdExporter = XSDExporter()
xsdExporter.exportSchema(schema, versionNumber, filePath)
def exportSchemaAsJSONSchema(schema, versionNumber, filePath):
"""
Exports the given schema as a JSON Schemas document.
Parameters
----------
schema : Schema
The schema to export.
versionNumber : string
The version number of the schema.
filePath : string
The path to which to save the JSON Schemas file.
Returns
-------
None
"""
jsonSchemasExporter = JSONSchemasExporter()
jsonSchemasExporter.exportSchema(schema, versionNumber, filePath)
def generateSpecification(schema, filePath):
"""
Generates a specification / human-readable documentation for the given schema. Some manual editing will be required,
but this function can save a lot of time.
Parameters
----------
schema : Schema
The schema to create a specification for.
filePath : string
The file path to which to save the specification.
Returns
-------
None
"""
specificationGenerator = SpecificationGenerator()
specificationGenerator.generateSpecification(schema, filePath)
def generateExampleXMLFiles(schema, folderPath):
"""
Generates example XML files for the given schema. Some manual editing will be required, but this function
can save time at the start of defining a new format.
Parameters
----------
schema : Schema
The schema to create example files for.
folderPath : string
The folder to which to save the example files.
Returns
-------
None
"""
exampleFileGenerator = ExampleFileGenerator()
exampleFileGenerator.generateExampleFiles(schema, folderPath)
| 0.720565 | 0.332256 |
import logging
logger = logging.getLogger("schemata.structures")
"""
This module contains the core classes for Schemata.
There are, broadly, three categories of class here.
The first is the Schema class, which simply represents the entire schema. It contains all of the structures.
The second is structure classes. A Schemata document consists of a set of different kinds of structures.
A structure might define an XML element, or an XML attribute, or a JSON object, and so on.
The third is usage references. A usage reference defines how one structure uses another structure. For example,
an element structure might want to refer to a number of attribute structures that it uses. However, these
attribute structures might be optional in this context, or have different default values to usual. This is what
the usage reference defines.
"""
class Schema(object):
"""
Represents a schema.
...
Attributes
----------
formatName : str
the name of this XML or JSON format
structures : list
the structures in this format
dependencies : list
the schemas on which this schema depends, if any
"""
def __init__(self):
self.formatName = ""
self.structures = []
self.dependencies = []
@property
def _allStructures(self):
return [structure for dependency in self.dependencies for structure in dependency.structures] + self.structures
def getStructureByReference(self, reference):
"""
Gets the structure with the given reference.
Parameters
----------
reference : str
the reference of the structure to get
Returns
-------
Either the structure with the given reference, or None if none is found.
"""
d = {structure.reference : structure for structure in self._allStructures}
return d.get(reference, None)
def getDataStructures(self):
"""
Gets all of the data structures in this schema.
Returns
-------
A list of data structures.
"""
return [structure for structure in self._allStructures if isinstance(structure, DataStructure)]
def getAttributeStructures(self):
"""
Gets all of the XML attribute structures in this schema.
Returns
-------
A list of attribute structures.
"""
return [structure for structure in self._allStructures if isinstance(structure, AttributeStructure)]
def getElementStructures(self):
"""
Gets all of the XML element structures in this schema.
Returns
-------
A list of element structures.
"""
return [structure for structure in self._allStructures if isinstance(structure, ElementStructure)]
def getRootElementStructures(self):
"""
Gets all of the XML root element structures in this schema.
Returns
-------
A list of element structures.
"""
return [structure for structure in self.getElementStructures() if structure.canBeRootElement]
def getNonRootElementStructures(self):
"""
Gets all of the XML non-root element structures in this schema.
Returns
-------
A list of element structures.
"""
return [structure for structure in self.getElementStructures() if not structure.canBeRootElement]
def getObjectStructures(self):
"""
Gets all of the JSON object structures in this schema.
Returns
-------
A list of object structures.
"""
return [structure for structure in self._allStructures if isinstance(structure, ObjectStructure)]
def getRootObjectStructures(self):
"""
Gets all of the JSON root object structures in this schema.
Returns
-------
A list of object structures.
"""
return [structure for structure in self.getObjectStructures() if structure.canBeRootObject]
def setIsUsed(self):
"""
Sets the isUsed property for every structure in the schema. This property determines whether or not a structure
will appear in the exported schema format, so this function must be called by the exporter at some point.
Returns
-------
None
"""
rootElementStructures = self.getRootElementStructures()
for rootElementStructure in rootElementStructures:
rootElementStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"formatName": self.formatName,
"structures": [structure.toJSON() if hasattr(structure, "toJSON") else structure for structure in self.structures]
}
class StructureMetadata(object):
"""
Captures the metadata for a structure. The metadata is used in automatic documentation generation.
...
Attributes
----------
description : str
a description of this structure
exampleValue : str
an example value for this structure, if relevant
"""
def __init__(self):
self.description = ""
self.exampleValue = ""
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"description": self.description,
"exampleValue": self.exampleValue
}
class Structure(object):
"""
A base class for all structures. Defines common properties.
...
Attributes
----------
schema : Schema
the schema that this structure is in
baseStructureReference : string
the reference of the base structure of this structure
baseStructure : Structure
the base structure of this structure
reference : string
the reference of this structure
isUsed : boolean
whether or not this structure is used in the schema
metadata : StructureMetadata
the metadata for this structure
"""
def __init__(self, reference = ""):
self.schema = None
self.baseStructureReference = ""
self.reference = reference
self.isUsed = False
self.metadata = StructureMetadata()
@property
def baseStructure(self):
return self.schema.getStructureByReference(self.baseStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
self.isUsed = True
if self.baseStructure != None:
self.baseStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {}
class DataStructure(Structure):
"""
A class for data structures.
...
Attributes
----------
allowedPattern : string
a regular expression describing what patterns this data structure can have (if the base type is a string)
allowedValues : list
a list of the different values that this data structure can have (effectively defining an enumeration); can be a list of strings or numbers
minimumValue : number
the minimum value (inclusive) that this data structure can have (if the base type is an integer or a decimal)
maximumValue : number
the maximum value (inclusive) that this data structure can have (if the base type is an integer or a decimal)
defaultValue : any
the default value that this data structure takes
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.allowedPattern = ""
self.allowedValues = []
self.minimumValue = None
self.maximumValue = None
self.defaultValue = None
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "DataStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"allowedPattern": self.allowedPattern,
"allowedValues": self.allowedValues,
"minimumValue": self.minimumValue,
"maximumValue": self.maximumValue,
"defaultValue": self.defaultValue
}
class ListFunction(object):
"""
A class that represents a kind of 'meta-data-structure'. If a list function is used in a Schemata file, it means that a data type should be used that is a
list of another data type. Adding list-like data types manually is tedious, as it often involves writing a very complex regular expression - list functions
do this automatically in Schemata.
...
Attributes
----------
schema : Schema
the schema that this list function is in
dataStructureReference : string
the reference of the data structure that this list function should be a list of
dataStructure : DataStructure
the data structure that this list function should be a list of
separator : string
the character or set of characters that should act as separators in this list - usually a comma or a semi-colon
"""
def __init__(self, dataStructureReference, separator):
self.schema = None
self.dataStructureReference = dataStructureReference
self.separator = separator
@property
def dataStructure(self):
return self.schema.getStructureByReference(self.dataStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structure this list function depends on.
Returns
-------
None
"""
if self.dataStructure != None:
self.dataStructure.setIsUsed()
class AttributeStructure(Structure):
"""
A class for XML attribute structures.
...
Attributes
----------
attributeName : string
the name of this XML attribute
dataStructureReference : string
the reference of the data structure that should be used as the value of this attribute
dataStructure : DataStructure
the data structure that should be used as the value of this attribute
defaultValue : any
the default value of this attribute; overrides the default value set by the data structure
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.attributeName = ""
self.dataStructureReference = ""
self.defaultValue = None
@property
def dataStructure(self):
return self.schema.getStructureByReference(self.dataStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
if self.dataStructure != None:
self.dataStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "AttributeStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"attributeName": self.attributeName,
"dataStructureReference": self.dataStructureReference,
"defaultValue": self.defaultValue
}
class ElementStructure(Structure):
"""
A class for XML element structures.
...
Attributes
----------
elementName : string
the tag name of this element
canBeRootElement : boolean
whether or not this element can be the root element of the XML document
attributes : list
a list of attribute usage references that specify what attributes this element can have
allowedContent : a type of UsageReference or StructureList
a hierarchical collection of objects defining what elements and data this element can contain
valueTypeReference : a string
if the content of this element is simply a value - i.e., a data structure - then this is the reference to that data structure
valueType : DataStructure
if the content of this element is simply a value - i.e., a data structure - then this is that data structure
isSelfClosing : boolean
whether or not this element should be self-closing; XSD is indifferent to whether elements are self-closing or not; this value
is mainly used in the auto-generation of documentation
lineBreaks : list of integers
how many line breaks there should be before the opening tag, after the opening tag, before the closing tag, and after the closing tag;
XSD is indifferent to the formatting of a given XML file; this value is mainly used in the auto-generation of documentation, and could
also be used by IDE extensions for auto-formatting
hasAttributes : boolean
whether or not this element has any allowed attributes; mainly used by the Schemata exporter
hasContent : boolean
whether or not this element has any allowed content; mainly used by the Schemata exporter
containsElementUsageReference : boolean
whether or not this element structure contains and element usage references; in short, whether
or not this element can contain other elements; mainly used by the Schemata exporter
containsAnyTextUsageReference : boolean
whether or not this element structure contains an 'any text' usage reference; in short, whether
or not this element can contain any text (rather than a specific text string defined by a data
structure); mainly used by the Schemata exporter
contentIsAnyText : boolean
whether or not this element can contain any text, but no elements; mainly used by the Schemata exporter
contentIsSingleValue : boolean
whether or not this element is a single value defined by a data structure; mainly used by the Schemata exporter
contentIsElementsOnly : boolean
whether or not this element can only contain other elements, and no text; mainly used by the Schemata exporter
contentIsElementsAndAnyText : boolean
whether or not this element is a mixed type - i.e., it can contain a mixture of subelements and
any text; common in HTML-like documents; mainly used by the Schemata exporter
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.elementName = ""
self.canBeRootElement = False
self.attributes = []
self.allowedContent = None
self.valueTypeReference = ""
self.isSelfClosing = False
self.lineBreaks = [0, 1, 1, 1]
@property
def hasAttributes(self):
return len(self.attributes) > 0
@property
def hasContent(self):
if self.allowedContent == None:
return False
if isinstance(self.allowedContent, StructureList) and len(self.allowedContent.structures) == 0:
return False
return True
@property
def containsElementUsageReference(self):
if isinstance(self.allowedContent, ElementUsageReference):
return True
if isinstance(self.allowedContent, AnyElementsUsageReference):
return True
if isinstance(self.allowedContent, StructureList):
# To do: this needs to be recursive.
if len([structure for structure in self.allowedContent.structures if isinstance(structure, ElementUsageReference) or isinstance(structure, AnyElementsUsageReference) or isinstance(structure, StructureList)]) > 0:
return True
return False
@property
def containsAnyTextUsageReference(self):
if isinstance(self.allowedContent, AnyTextUsageReference):
return True
if isinstance(self.allowedContent, StructureList):
if len([structure for structure in self.allowedContent.structures if isinstance(structure, AnyTextUsageReference)]) > 0:
return True
return False
@property
def contentIsAnyText(self):
return self.containsAnyTextUsageReference and not self.containsElementUsageReference
@property
def contentIsSingleValue(self):
return isinstance(self.allowedContent, DataUsageReference)
@property
def contentIsElementsOnly(self):
return self.containsElementUsageReference and not self.containsAnyTextUsageReference
@property
def contentIsElementsAndAnyText(self):
return self.containsElementUsageReference and self.containsAnyTextUsageReference
@property
def valueType(self):
return self.schema.getStructureByReference(self.valueTypeReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
for attributeUsageReference in self.attributes:
logger.info(f"Setting isUsed for {self.reference}.{attributeUsageReference.attributeStructureReference}.")
attributeUsageReference.attributeStructure.setIsUsed()
if self.allowedContent != None:
self.allowedContent.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "ElementStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"elementName": self.elementName,
"canBeRootElement": self.canBeRootElement,
"attributes": [a.toJSON() for a in self.attributes],
"allowedContent": None if self.allowedContent == None else self.allowedContent.toJSON(),
"isSelfClosing": self.isSelfClosing,
"lineBreaks": self.lineBreaks
}
class PropertyStructure(Structure):
"""
A class for JSON property structures.
...
Attributes
----------
propertyName : string
the name of this JSON property
valueTypeReference : string
the reference of the structure that the value of this property should be
valueType : Structure
the structure that the value of this property should be; can be a data structure, an array structure, or an object structure
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.propertyName = ""
self.valueTypeReference = ""
@property
def valueType(self):
return self.schema.getStructureByReference(self.valueTypeReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
if self.valueType != None:
self.valueType.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "PropertyStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"valueTypeReference": self.valueTypeReference
}
class ArrayStructure(Structure):
"""
A class for JSON array structures.
...
Attributes
----------
itemTypeReference : string
the reference to the structure that all of the items of this array conform to
itemType : Structure
the structure that all of the items of this array conform to; can be a data structure, an array structure, or an object structure
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.itemTypeReference = ""
@property
def itemType(self):
return self.schema.getStructureByReference(self.itemTypeReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
if self.itemType != None:
self.itemType.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "ArrayStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed ,
"metadata": self.metadata.toJSON(),
"itemTypeReference": self.itemTypeReference
}
class ObjectStructure(Structure):
"""
A class for JSON object structures.
...
Attributes
----------
canBeRootObject : boolean
whether or not this object structure can be the root object of the JSON document
properties : list
a list of property usage references that defines the properties this object can have
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.canBeRootObject = False
self.properties = []
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
for propertyUsageReference in self.properties:
propertyUsageReference.propertyStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "ObjectStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"canBeRootObject": self.canBeRootObject,
"properties": [p.toJSON() for p in self.properties]
}
class UsageReference(object):
"""
A usage reference base class. While structures *define* things like elements or objects, usage references are statements of how and where they are used.
A usage reference includes things like whether an attribute is optional, or how many times a subelement should be repeated.
...
Attributes
----------
schema : Schema
the schema that this usage reference is used in.
"""
def __init__(self):
self.schema = None
def setIsUsed(self):
pass
def toJSON(self):
return {}
class DataUsageReference(UsageReference):
"""
A class for a data structure usage reference.
...
Attributes
----------
dataStructureReference : string
the reference of the data structure that this usage reference pertains to
dataStructure : DataStructure
the data structure that this usage reference pertains to
"""
def __init__(self):
super().__init__()
self.dataStructureReference = ""
@property
def dataStructure(self):
return self.schema.getStructureByReference(self.dataStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structures this usage reference depends on.
Returns
-------
None
"""
if self.dataStructure != None:
self.dataStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"dataStructureReference": self.dataStructureReference
}
class AttributeUsageReference(UsageReference):
"""
A class for an attribute structure usage reference.
...
Attributes
----------
attributeStructureReference : string
the reference of the attribute structure this usage reference pertains to
attributeStructure : AttributeStructure
the attribute structure this usage reference pertains to
isOptional : boolean
whether or not this attribute is optional in this context
defaultValue : any
the default value of this attribute in this context; overrides the default value set by the attribute structure and the default value set by the value data structure
"""
def __init__(self):
super().__init__()
self.attributeStructureReference = ""
self.isOptional = False
self.defaultValue = None
@property
def attributeStructure(self):
return self.schema.getStructureByReference(self.attributeStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structures this usage reference depends on.
Returns
-------
None
"""
if self.attributeStructure != None:
self.attributeStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"attributeStructureReference": self.attributeStructureReference,
"isOptional": self.isOptional,
"defaultValue": self.defaultValue
}
class ElementUsageReference(UsageReference):
"""
A class for an element structure usage reference.
...
Attributes
----------
elementStructureReference : string
the reference of the element structure that this usage reference pertains to
elementStructure : ElementStructure
the element structure that this usage reference pertains to
nExpression : array of tuples
an array of tuples defining the limits of how many repeats of this element there should be
minimumNumberOfOccurrences : integer
the minimum number of occurrences (inclusive) that there must be of this element
maximumNumberOfOccurrences : integer
the maximum number of occurrences (inclusive) that there must be of this element
"""
def __init__(self):
super().__init__()
self.elementStructureReference= ""
self.nExpression = None
self.minimumNumberOfOccurrences = 1
self.maximumNumberOfOccurrences = 1
@property
def elementStructure(self):
return self.schema.getStructureByReference(self.elementStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structures this usage reference depends on.
Returns
-------
None
"""
if self.elementStructure != None:
self.elementStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"elementStructureReference": self.elementStructureReference,
"minimumNumberOfOccurrences": self.minimumNumberOfOccurrences,
"maximumNumberOfOccurrences": self.maximumNumberOfOccurrences
}
class PropertyUsageReference(UsageReference):
"""
A class for a property structure usage reference.
...
Attributes
----------
propertyStructureReference : string
the reference of the property structure that this usage reference pertains to
propertyStructure : PropertyStructure
the property structure that this usage reference pertains to
isOptional : boolean
whether this property is optional in this context
defaultValue : any
the default value of this property in this context
"""
def __init__(self):
super().__init__()
self.propertyStructureReference = ""
self.isOptional = False
self.defaultValue = None
@property
def propertyStructure(self):
return self.schema.getStructureByReference(self.propertyStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structures this usage reference depends on.
Returns
-------
None
"""
if self.propertyStructure != None:
self.propertyStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"propertyStructureReference": self.propertyStructureReference,
"isOptional": self.isOptional,
"defaultValue": self.defaultValue
}
class AnyAttributesUsageReference(UsageReference):
"""
A class for a wildcard usage reference that indicates that any attributes can be attached to an element.
"""
pass
class AnyElementsUsageReference(UsageReference):
"""
A class for a wildcard usage reference that indicates that any element can be a subelement of an element.
"""
pass
class AnyTextUsageReference(UsageReference):
"""
A class for a wildcard usage reference that indicates any text can be contained within an element.
"""
pass
class AnyPropertiesUsageReference(UsageReference):
"""
A class for a wildcard usage reference that indicates that any properties can be attached to an object.
"""
pass
class StructureList(object):
"""
Represents a list of structures usage references. This is used in the allowedContent property of the ElementStructure class.
This is the base class. Derived classes specify whether the structures must appear in order, or whether the list represents a choice between structures.
...
Attributes
----------
schema : Schema
the schema that this structure list is in
structures : list
the structure usage references in this list
containsText : boolean
whether this structure list contains an AnyTextUsageReference, at any level of depth
"""
def __init__(self):
self.schema = None
self.structures = []
@property
def containsText(self):
for structureUsageReference in self.structures:
if isinstance(structureUsageReference, AnyTextUsageReference):
return True
if isinstance(structureUsageReference, UnorderedStructureList):
containsText = structureUsageReference.containsText()
if containsText == True:
return True
if isinstance(structureUsageReference, OrderedStructureList):
containsText = structureUsageReference.containsText()
if containsText == True:
return True
if isinstance(structureUsageReference, StructureChoice):
containsText = structureUsageReference.containsText()
if containsText == True:
return True
def setIsUsed(self):
"""
Sets the isUsed property for the structures this list depends on.
Returns
-------
None
"""
for structureUsageReference in self.structures:
structureUsageReference.setIsUsed()
def toJSON(self):
return {}
class UnorderedStructureList(StructureList):
"""
Represents a type of structure list where the order is not important.
"""
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "UnorderedStructureList",
"structures": [structure.toJSON() for structure in self.structures]
}
class OrderedStructureList(StructureList):
"""
Represents a type of structure list where the order is important.
"""
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "OrderedStructureList",
"structures": [structure.toJSON() for structure in self.structures]
}
class StructureChoice(StructureList):
"""
Represents a type of structure list where only one of the structures can be used.
"""
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "StructureChoice",
"structures": [structure.toJSON() for structure in self.structures]
}
|
schematacode
|
/schematacode-1.0.1.tar.gz/schematacode-1.0.1/schemata/structures.py
|
structures.py
|
import logging
logger = logging.getLogger("schemata.structures")
"""
This module contains the core classes for Schemata.
There are, broadly, three categories of class here.
The first is the Schema class, which simply represents the entire schema. It contains all of the structures.
The second is structure classes. A Schemata document consists of a set of different kinds of structures.
A structure might define an XML element, or an XML attribute, or a JSON object, and so on.
The third is usage references. A usage reference defines how one structure uses another structure. For example,
an element structure might want to refer to a number of attribute structures that it uses. However, these
attribute structures might be optional in this context, or have different default values to usual. This is what
the usage reference defines.
"""
class Schema(object):
"""
Represents a schema.
...
Attributes
----------
formatName : str
the name of this XML or JSON format
structures : list
the structures in this format
dependencies : list
the schemas on which this schema depends, if any
"""
def __init__(self):
self.formatName = ""
self.structures = []
self.dependencies = []
@property
def _allStructures(self):
return [structure for dependency in self.dependencies for structure in dependency.structures] + self.structures
def getStructureByReference(self, reference):
"""
Gets the structure with the given reference.
Parameters
----------
reference : str
the reference of the structure to get
Returns
-------
Either the structure with the given reference, or None if none is found.
"""
d = {structure.reference : structure for structure in self._allStructures}
return d.get(reference, None)
def getDataStructures(self):
"""
Gets all of the data structures in this schema.
Returns
-------
A list of data structures.
"""
return [structure for structure in self._allStructures if isinstance(structure, DataStructure)]
def getAttributeStructures(self):
"""
Gets all of the XML attribute structures in this schema.
Returns
-------
A list of attribute structures.
"""
return [structure for structure in self._allStructures if isinstance(structure, AttributeStructure)]
def getElementStructures(self):
"""
Gets all of the XML element structures in this schema.
Returns
-------
A list of element structures.
"""
return [structure for structure in self._allStructures if isinstance(structure, ElementStructure)]
def getRootElementStructures(self):
"""
Gets all of the XML root element structures in this schema.
Returns
-------
A list of element structures.
"""
return [structure for structure in self.getElementStructures() if structure.canBeRootElement]
def getNonRootElementStructures(self):
"""
Gets all of the XML non-root element structures in this schema.
Returns
-------
A list of element structures.
"""
return [structure for structure in self.getElementStructures() if not structure.canBeRootElement]
def getObjectStructures(self):
"""
Gets all of the JSON object structures in this schema.
Returns
-------
A list of object structures.
"""
return [structure for structure in self._allStructures if isinstance(structure, ObjectStructure)]
def getRootObjectStructures(self):
"""
Gets all of the JSON root object structures in this schema.
Returns
-------
A list of object structures.
"""
return [structure for structure in self.getObjectStructures() if structure.canBeRootObject]
def setIsUsed(self):
"""
Sets the isUsed property for every structure in the schema. This property determines whether or not a structure
will appear in the exported schema format, so this function must be called by the exporter at some point.
Returns
-------
None
"""
rootElementStructures = self.getRootElementStructures()
for rootElementStructure in rootElementStructures:
rootElementStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"formatName": self.formatName,
"structures": [structure.toJSON() if hasattr(structure, "toJSON") else structure for structure in self.structures]
}
class StructureMetadata(object):
"""
Captures the metadata for a structure. The metadata is used in automatic documentation generation.
...
Attributes
----------
description : str
a description of this structure
exampleValue : str
an example value for this structure, if relevant
"""
def __init__(self):
self.description = ""
self.exampleValue = ""
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"description": self.description,
"exampleValue": self.exampleValue
}
class Structure(object):
"""
A base class for all structures. Defines common properties.
...
Attributes
----------
schema : Schema
the schema that this structure is in
baseStructureReference : string
the reference of the base structure of this structure
baseStructure : Structure
the base structure of this structure
reference : string
the reference of this structure
isUsed : boolean
whether or not this structure is used in the schema
metadata : StructureMetadata
the metadata for this structure
"""
def __init__(self, reference = ""):
self.schema = None
self.baseStructureReference = ""
self.reference = reference
self.isUsed = False
self.metadata = StructureMetadata()
@property
def baseStructure(self):
return self.schema.getStructureByReference(self.baseStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
self.isUsed = True
if self.baseStructure != None:
self.baseStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {}
class DataStructure(Structure):
"""
A class for data structures.
...
Attributes
----------
allowedPattern : string
a regular expression describing what patterns this data structure can have (if the base type is a string)
allowedValues : list
a list of the different values that this data structure can have (effectively defining an enumeration); can be a list of strings or numbers
minimumValue : number
the minimum value (inclusive) that this data structure can have (if the base type is an integer or a decimal)
maximumValue : number
the maximum value (inclusive) that this data structure can have (if the base type is an integer or a decimal)
defaultValue : any
the default value that this data structure takes
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.allowedPattern = ""
self.allowedValues = []
self.minimumValue = None
self.maximumValue = None
self.defaultValue = None
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "DataStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"allowedPattern": self.allowedPattern,
"allowedValues": self.allowedValues,
"minimumValue": self.minimumValue,
"maximumValue": self.maximumValue,
"defaultValue": self.defaultValue
}
class ListFunction(object):
"""
A class that represents a kind of 'meta-data-structure'. If a list function is used in a Schemata file, it means that a data type should be used that is a
list of another data type. Adding list-like data types manually is tedious, as it often involves writing a very complex regular expression - list functions
do this automatically in Schemata.
...
Attributes
----------
schema : Schema
the schema that this list function is in
dataStructureReference : string
the reference of the data structure that this list function should be a list of
dataStructure : DataStructure
the data structure that this list function should be a list of
separator : string
the character or set of characters that should act as separators in this list - usually a comma or a semi-colon
"""
def __init__(self, dataStructureReference, separator):
self.schema = None
self.dataStructureReference = dataStructureReference
self.separator = separator
@property
def dataStructure(self):
return self.schema.getStructureByReference(self.dataStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structure this list function depends on.
Returns
-------
None
"""
if self.dataStructure != None:
self.dataStructure.setIsUsed()
class AttributeStructure(Structure):
"""
A class for XML attribute structures.
...
Attributes
----------
attributeName : string
the name of this XML attribute
dataStructureReference : string
the reference of the data structure that should be used as the value of this attribute
dataStructure : DataStructure
the data structure that should be used as the value of this attribute
defaultValue : any
the default value of this attribute; overrides the default value set by the data structure
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.attributeName = ""
self.dataStructureReference = ""
self.defaultValue = None
@property
def dataStructure(self):
return self.schema.getStructureByReference(self.dataStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
if self.dataStructure != None:
self.dataStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "AttributeStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"attributeName": self.attributeName,
"dataStructureReference": self.dataStructureReference,
"defaultValue": self.defaultValue
}
class ElementStructure(Structure):
"""
A class for XML element structures.
...
Attributes
----------
elementName : string
the tag name of this element
canBeRootElement : boolean
whether or not this element can be the root element of the XML document
attributes : list
a list of attribute usage references that specify what attributes this element can have
allowedContent : a type of UsageReference or StructureList
a hierarchical collection of objects defining what elements and data this element can contain
valueTypeReference : a string
if the content of this element is simply a value - i.e., a data structure - then this is the reference to that data structure
valueType : DataStructure
if the content of this element is simply a value - i.e., a data structure - then this is that data structure
isSelfClosing : boolean
whether or not this element should be self-closing; XSD is indifferent to whether elements are self-closing or not; this value
is mainly used in the auto-generation of documentation
lineBreaks : list of integers
how many line breaks there should be before the opening tag, after the opening tag, before the closing tag, and after the closing tag;
XSD is indifferent to the formatting of a given XML file; this value is mainly used in the auto-generation of documentation, and could
also be used by IDE extensions for auto-formatting
hasAttributes : boolean
whether or not this element has any allowed attributes; mainly used by the Schemata exporter
hasContent : boolean
whether or not this element has any allowed content; mainly used by the Schemata exporter
containsElementUsageReference : boolean
whether or not this element structure contains and element usage references; in short, whether
or not this element can contain other elements; mainly used by the Schemata exporter
containsAnyTextUsageReference : boolean
whether or not this element structure contains an 'any text' usage reference; in short, whether
or not this element can contain any text (rather than a specific text string defined by a data
structure); mainly used by the Schemata exporter
contentIsAnyText : boolean
whether or not this element can contain any text, but no elements; mainly used by the Schemata exporter
contentIsSingleValue : boolean
whether or not this element is a single value defined by a data structure; mainly used by the Schemata exporter
contentIsElementsOnly : boolean
whether or not this element can only contain other elements, and no text; mainly used by the Schemata exporter
contentIsElementsAndAnyText : boolean
whether or not this element is a mixed type - i.e., it can contain a mixture of subelements and
any text; common in HTML-like documents; mainly used by the Schemata exporter
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.elementName = ""
self.canBeRootElement = False
self.attributes = []
self.allowedContent = None
self.valueTypeReference = ""
self.isSelfClosing = False
self.lineBreaks = [0, 1, 1, 1]
@property
def hasAttributes(self):
return len(self.attributes) > 0
@property
def hasContent(self):
if self.allowedContent == None:
return False
if isinstance(self.allowedContent, StructureList) and len(self.allowedContent.structures) == 0:
return False
return True
@property
def containsElementUsageReference(self):
if isinstance(self.allowedContent, ElementUsageReference):
return True
if isinstance(self.allowedContent, AnyElementsUsageReference):
return True
if isinstance(self.allowedContent, StructureList):
# To do: this needs to be recursive.
if len([structure for structure in self.allowedContent.structures if isinstance(structure, ElementUsageReference) or isinstance(structure, AnyElementsUsageReference) or isinstance(structure, StructureList)]) > 0:
return True
return False
@property
def containsAnyTextUsageReference(self):
if isinstance(self.allowedContent, AnyTextUsageReference):
return True
if isinstance(self.allowedContent, StructureList):
if len([structure for structure in self.allowedContent.structures if isinstance(structure, AnyTextUsageReference)]) > 0:
return True
return False
@property
def contentIsAnyText(self):
return self.containsAnyTextUsageReference and not self.containsElementUsageReference
@property
def contentIsSingleValue(self):
return isinstance(self.allowedContent, DataUsageReference)
@property
def contentIsElementsOnly(self):
return self.containsElementUsageReference and not self.containsAnyTextUsageReference
@property
def contentIsElementsAndAnyText(self):
return self.containsElementUsageReference and self.containsAnyTextUsageReference
@property
def valueType(self):
return self.schema.getStructureByReference(self.valueTypeReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
for attributeUsageReference in self.attributes:
logger.info(f"Setting isUsed for {self.reference}.{attributeUsageReference.attributeStructureReference}.")
attributeUsageReference.attributeStructure.setIsUsed()
if self.allowedContent != None:
self.allowedContent.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "ElementStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"elementName": self.elementName,
"canBeRootElement": self.canBeRootElement,
"attributes": [a.toJSON() for a in self.attributes],
"allowedContent": None if self.allowedContent == None else self.allowedContent.toJSON(),
"isSelfClosing": self.isSelfClosing,
"lineBreaks": self.lineBreaks
}
class PropertyStructure(Structure):
"""
A class for JSON property structures.
...
Attributes
----------
propertyName : string
the name of this JSON property
valueTypeReference : string
the reference of the structure that the value of this property should be
valueType : Structure
the structure that the value of this property should be; can be a data structure, an array structure, or an object structure
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.propertyName = ""
self.valueTypeReference = ""
@property
def valueType(self):
return self.schema.getStructureByReference(self.valueTypeReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
if self.valueType != None:
self.valueType.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "PropertyStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"valueTypeReference": self.valueTypeReference
}
class ArrayStructure(Structure):
"""
A class for JSON array structures.
...
Attributes
----------
itemTypeReference : string
the reference to the structure that all of the items of this array conform to
itemType : Structure
the structure that all of the items of this array conform to; can be a data structure, an array structure, or an object structure
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.itemTypeReference = ""
@property
def itemType(self):
return self.schema.getStructureByReference(self.itemTypeReference)
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
if self.itemType != None:
self.itemType.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "ArrayStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed ,
"metadata": self.metadata.toJSON(),
"itemTypeReference": self.itemTypeReference
}
class ObjectStructure(Structure):
"""
A class for JSON object structures.
...
Attributes
----------
canBeRootObject : boolean
whether or not this object structure can be the root object of the JSON document
properties : list
a list of property usage references that defines the properties this object can have
"""
def __init__(self, reference = ""):
super().__init__(reference)
self.canBeRootObject = False
self.properties = []
def setIsUsed(self):
"""
Sets the isUsed property for this structure and the structures it depends on.
Returns
-------
None
"""
super().setIsUsed()
for propertyUsageReference in self.properties:
propertyUsageReference.propertyStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "ObjectStructure",
"baseStructureReference": self.baseStructureReference,
"reference": self.reference,
"isUsed": self.isUsed,
"metadata": self.metadata.toJSON(),
"canBeRootObject": self.canBeRootObject,
"properties": [p.toJSON() for p in self.properties]
}
class UsageReference(object):
"""
A usage reference base class. While structures *define* things like elements or objects, usage references are statements of how and where they are used.
A usage reference includes things like whether an attribute is optional, or how many times a subelement should be repeated.
...
Attributes
----------
schema : Schema
the schema that this usage reference is used in.
"""
def __init__(self):
self.schema = None
def setIsUsed(self):
pass
def toJSON(self):
return {}
class DataUsageReference(UsageReference):
"""
A class for a data structure usage reference.
...
Attributes
----------
dataStructureReference : string
the reference of the data structure that this usage reference pertains to
dataStructure : DataStructure
the data structure that this usage reference pertains to
"""
def __init__(self):
super().__init__()
self.dataStructureReference = ""
@property
def dataStructure(self):
return self.schema.getStructureByReference(self.dataStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structures this usage reference depends on.
Returns
-------
None
"""
if self.dataStructure != None:
self.dataStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"dataStructureReference": self.dataStructureReference
}
class AttributeUsageReference(UsageReference):
"""
A class for an attribute structure usage reference.
...
Attributes
----------
attributeStructureReference : string
the reference of the attribute structure this usage reference pertains to
attributeStructure : AttributeStructure
the attribute structure this usage reference pertains to
isOptional : boolean
whether or not this attribute is optional in this context
defaultValue : any
the default value of this attribute in this context; overrides the default value set by the attribute structure and the default value set by the value data structure
"""
def __init__(self):
super().__init__()
self.attributeStructureReference = ""
self.isOptional = False
self.defaultValue = None
@property
def attributeStructure(self):
return self.schema.getStructureByReference(self.attributeStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structures this usage reference depends on.
Returns
-------
None
"""
if self.attributeStructure != None:
self.attributeStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"attributeStructureReference": self.attributeStructureReference,
"isOptional": self.isOptional,
"defaultValue": self.defaultValue
}
class ElementUsageReference(UsageReference):
"""
A class for an element structure usage reference.
...
Attributes
----------
elementStructureReference : string
the reference of the element structure that this usage reference pertains to
elementStructure : ElementStructure
the element structure that this usage reference pertains to
nExpression : array of tuples
an array of tuples defining the limits of how many repeats of this element there should be
minimumNumberOfOccurrences : integer
the minimum number of occurrences (inclusive) that there must be of this element
maximumNumberOfOccurrences : integer
the maximum number of occurrences (inclusive) that there must be of this element
"""
def __init__(self):
super().__init__()
self.elementStructureReference= ""
self.nExpression = None
self.minimumNumberOfOccurrences = 1
self.maximumNumberOfOccurrences = 1
@property
def elementStructure(self):
return self.schema.getStructureByReference(self.elementStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structures this usage reference depends on.
Returns
-------
None
"""
if self.elementStructure != None:
self.elementStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"elementStructureReference": self.elementStructureReference,
"minimumNumberOfOccurrences": self.minimumNumberOfOccurrences,
"maximumNumberOfOccurrences": self.maximumNumberOfOccurrences
}
class PropertyUsageReference(UsageReference):
"""
A class for a property structure usage reference.
...
Attributes
----------
propertyStructureReference : string
the reference of the property structure that this usage reference pertains to
propertyStructure : PropertyStructure
the property structure that this usage reference pertains to
isOptional : boolean
whether this property is optional in this context
defaultValue : any
the default value of this property in this context
"""
def __init__(self):
super().__init__()
self.propertyStructureReference = ""
self.isOptional = False
self.defaultValue = None
@property
def propertyStructure(self):
return self.schema.getStructureByReference(self.propertyStructureReference)
def setIsUsed(self):
"""
Sets the isUsed property for the structures this usage reference depends on.
Returns
-------
None
"""
if self.propertyStructure != None:
self.propertyStructure.setIsUsed()
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"propertyStructureReference": self.propertyStructureReference,
"isOptional": self.isOptional,
"defaultValue": self.defaultValue
}
class AnyAttributesUsageReference(UsageReference):
"""
A class for a wildcard usage reference that indicates that any attributes can be attached to an element.
"""
pass
class AnyElementsUsageReference(UsageReference):
"""
A class for a wildcard usage reference that indicates that any element can be a subelement of an element.
"""
pass
class AnyTextUsageReference(UsageReference):
"""
A class for a wildcard usage reference that indicates any text can be contained within an element.
"""
pass
class AnyPropertiesUsageReference(UsageReference):
"""
A class for a wildcard usage reference that indicates that any properties can be attached to an object.
"""
pass
class StructureList(object):
"""
Represents a list of structures usage references. This is used in the allowedContent property of the ElementStructure class.
This is the base class. Derived classes specify whether the structures must appear in order, or whether the list represents a choice between structures.
...
Attributes
----------
schema : Schema
the schema that this structure list is in
structures : list
the structure usage references in this list
containsText : boolean
whether this structure list contains an AnyTextUsageReference, at any level of depth
"""
def __init__(self):
self.schema = None
self.structures = []
@property
def containsText(self):
for structureUsageReference in self.structures:
if isinstance(structureUsageReference, AnyTextUsageReference):
return True
if isinstance(structureUsageReference, UnorderedStructureList):
containsText = structureUsageReference.containsText()
if containsText == True:
return True
if isinstance(structureUsageReference, OrderedStructureList):
containsText = structureUsageReference.containsText()
if containsText == True:
return True
if isinstance(structureUsageReference, StructureChoice):
containsText = structureUsageReference.containsText()
if containsText == True:
return True
def setIsUsed(self):
"""
Sets the isUsed property for the structures this list depends on.
Returns
-------
None
"""
for structureUsageReference in self.structures:
structureUsageReference.setIsUsed()
def toJSON(self):
return {}
class UnorderedStructureList(StructureList):
"""
Represents a type of structure list where the order is not important.
"""
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "UnorderedStructureList",
"structures": [structure.toJSON() for structure in self.structures]
}
class OrderedStructureList(StructureList):
"""
Represents a type of structure list where the order is important.
"""
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "OrderedStructureList",
"structures": [structure.toJSON() for structure in self.structures]
}
class StructureChoice(StructureList):
"""
Represents a type of structure list where only one of the structures can be used.
"""
def toJSON(self):
"""
Converts this object to a dictionary, which can then be easily exported as JSON. Used for development purposes.
Returns
-------
A dictionary representing this object.
"""
return {
"type": "StructureChoice",
"structures": [structure.toJSON() for structure in self.structures]
}
| 0.909902 | 0.677607 |
import os
import logging
import re
from lxml.etree import ElementTree as XMLElementTree, Element as XMLElement, SubElement as XMLSubelement, Comment as XMLComment, QName, indent
import json
from schemata.structures import *
logger = logging.getLogger("schemata.parser")
"""
This module contains the Schemata parser.
This module contains the code that takes Schemata syntax - a relatively compact syntax - and turns it into
a set of objects representing the schema. From there, the schema can be exported to XSD, or Schematron, or
JSON Schemas, or auto-generated documentation, depending on what's relevant.
The parsing is done completely in one step. The parser scans the document and constructs the objects in one go.
"""
class Marker(object):
def __init__(self):
self.position = 0
def copy(self):
marker = Marker()
marker.position = self.position
return marker
def cut(text, startIndex, length=1):
a = startIndex
b = startIndex + length
return text[a:b]
class SchemataParsingError(Exception):
def __init__(self, message):
super().__init__(message)
class Parser(object):
_propertyNameCharacters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-"
_referenceCharacters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-"
_operators = ["=", ">", ">=", "<", "<=", "/="]
_negatedOperators = ["=", "<", "<=", ">", ">=", "/="]
_propertyNames = [
"baseType",
"tagName",
"allowedPattern",
"allowedValues",
"minimumValue",
"maximumValue",
"defaultValue",
"valueType",
"attributes",
"allowedContent",
"itemType",
"properties",
"isSelfClosing",
"lineBreaks"
]
def __init__(self):
pass
def parseSchemaFromFile(self, filePath):
with open(filePath, "r") as fileObject:
text = fileObject.read()
schema = self.parseSchema(text, filePath)
return schema
def parseSchema(self, inputText, filePath = ""):
logger.debug("Attempting to parse schema.")
marker = Marker()
schema = Schema()
self._parseWhiteSpace(inputText, marker)
logger.debug("Attempting to parse schema metadata.")
metadata = self._parseComment(inputText, marker)
if metadata != None:
logger.debug("Found metadata comment.")
m = re.search(r"Format Name:\s*(.+)\n", metadata)
if m != None:
schema.formatName = m.group(1).strip()
logger.debug(f"Got format name '{schema.formatName}'.")
importStatements = self._parseImportStatements(inputText, marker, schema)
for i in importStatements:
path = os.path.join(os.path.dirname(filePath), i)
if not os.path.exists(path):
raise Exception(f"'{path}' does not exist.")
s = self.parseSchemaFromFile(path)
schema.dependencies.append(s)
schema.structures = self._parseStructures(inputText, marker, schema)
for structure in schema.structures:
if isinstance(structure, ElementStructure) and isinstance(structure.allowedContent, ElementUsageReference):
s = structure.allowedContent.elementStructure
if isinstance(s, DataStructure):
structure.valueTypeReference = s.reference
ds = DataUsageReference()
ds.schema = schema
ds.dataStructureReference = s.reference
structure.allowedContent =ds
listDataStructures = []
for structure in schema.structures:
if isinstance(structure, AttributeStructure) and isinstance(structure.dataStructureReference, ListFunction):
lf = structure.dataStructureReference
ds1 = lf.dataStructure
ds1.setIsUsed()
pattern = ""
if ds1.allowedValues:
pattern = "|".join(ds1.allowedValues)
elif ds1.allowedPattern != "":
pattern = ds1.allowedPattern
ds2 = DataStructure()
ds2.schema = schema
ds2.reference = f"list_of__{ds1.reference}"
ds2.baseStructureReference = "string"
ds2.allowedPattern = "({})(\s*{}\s*({}))*".format(pattern, lf.separator, pattern)
logger.debug("Creating list structure '{}'.".format(ds2.reference))
structure.dataStructureReference = ds2.reference
listDataStructures.append(ds2)
logger.debug(f"Created {len(listDataStructures)} list data structures.")
schema.structures += listDataStructures
schema.setIsUsed()
logger.debug("Schema structures: {}".format(", ".join([str(structure) for structure in schema.structures])))
return schema
def _parseImportStatements(self, inputText, marker, schema = None):
logger.debug("Getting import statements.")
self._parseWhiteSpace(inputText, marker)
importStatements = []
while marker.position < len(inputText):
i = self._parseImportStatement(inputText, marker, schema)
if i != None:
importStatements.append(i)
else:
break
logger.debug(f"{len(importStatements)} import statements found.")
return importStatements
def _parseImportStatement(self, inputText, marker, schema = None):
logger.debug("Attempting to parse import statement.")
self._parseWhiteSpace(inputText, marker)
if cut(inputText, marker.position, 6) == "import":
marker.position += 6
self._parseWhiteSpace(inputText, marker)
path = self._parseString(inputText, marker)
if path == None or path == "":
raise SchemataParsingError(f"Expected a path string at {marker.position}.")
logger.debug(f"Found path '{path}'.")
return path
return None
def _parseStructures(self, inputText, marker, schema = None):
logger.debug("Attempting to parse structures.")
structures = []
references = []
while marker.position < len(inputText):
self._parseWhiteSpace(inputText, marker)
self._parseComment(inputText, marker)
structure = self._parseStructure(inputText, marker, schema)
if structure != None:
if structure.reference in references:
raise SchemataParsingError(f"A structure with the reference '{structure.reference}' has already been defined.")
structures.append(structure)
references.append(structure.reference)
logger.debug(f"Found {len(structures)} structures.")
return structures
def _parseStructure(self, inputText, marker, schema = None):
logger.debug("Attempting to parse structure.")
self._parseWhiteSpace(inputText, marker)
if cut(inputText, marker.position, 8) == "dataType":
marker.position += 8
logger.debug("Found data structure.")
dataStructure = self._parseDataStructure(inputText, marker, schema)
return dataStructure
if cut(inputText, marker.position, 9) == "attribute":
marker.position += 9
logger.debug("Found attribute structure.")
attributeStructure = self._parseAttributeStructure(inputText, marker, schema)
return attributeStructure
if cut(inputText, marker.position, 4) == "root":
marker.position += 4
self._parseWhiteSpace(inputText, marker)
if cut(inputText, marker.position, 7) == "element":
marker.position += 7
logger.debug("Found root element structure.")
elementStructure = self._parseElementStructure(inputText, marker, schema)
elementStructure.canBeRootElement = True
return elementStructure
elif cut(inputText, marker.position, 6) == "object":
marker.position += 6
logger.debug("Found root object structure.")
objectStructure = self._parseObjectStructure(inputText, marker, schema)
objectStructure.canBeRootObject = True
return objectStructure
else:
raise SchemataParsingError(f"Expected 'element' keyword at position {marker.position}.")
if cut(inputText, marker.position, 7) == "element":
marker.position += 7
logger.debug("Found element structure.")
elementStructure = self._parseElementStructure(inputText, marker, schema)
return elementStructure
if cut(inputText, marker.position, 8) == "property":
marker.position += 8
logger.debug("Found property structure.")
propertyStructure = self._parsePropertyStructure(inputText, marker, schema)
return propertyStructure
if cut(inputText, marker.position, 5) == "array":
marker.position += 5
logger.debug("Found array structure.")
arrayStructure = self._parseArrayStructure(inputText, marker, schema)
return arrayStructure
if cut(inputText, marker.position, 6) == "object":
marker.position += 6
logger.debug("Found object structure.")
objectStructure = self._parseObjectStructure(inputText, marker, schema)
return objectStructure
return None
def _parseDataStructure(self, inputText, marker, schema = None):
""" Gets any data structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
dataStructure = DataStructure()
dataStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
dataStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
dataStructure.metadata.description = m1.group(1).strip()
if m2 != None:
dataStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
dataStructure.baseStructureReference = p[1]
if p[0] == "allowedPattern":
dataStructure.allowedPattern = p[1]
if p[0] == "allowedValues":
dataStructure.allowedValues = p[1]
if p[0] == "minimumValue":
dataStructure.minimumValue = p[1]
if p[0] == "maximumValue":
dataStructure.maximumValue = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
return dataStructure
def _parseAttributeStructure(self, inputText, marker, schema = None):
""" Gets any attribute structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
attributeStructure = AttributeStructure()
attributeStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
attributeStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
attributeStructure.metadata.description = m1.group(1).strip()
if m2 != None:
attributeStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
attributeStructure.baseStructureReference = p[1]
if p[0] == "tagName":
attributeStructure.attributeName = p[1]
if p[0] == "valueType":
attributeStructure.dataStructureReference = p[1]
if p[0] == "defaultValue":
attributeStructure.defaultValue = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
# If the attribute name has not been set explicitly, use the attribute structure reference.
# This allows .schema files to be terse.
if attributeStructure.attributeName == "":
attributeStructure.attributeName = attributeStructure.reference
return attributeStructure
def _parseElementStructure(self, inputText, marker, schema = None):
""" Gets any element structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
elementStructure = ElementStructure()
elementStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
elementStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
elementStructure.metadata.description = m1.group(1).strip()
if m2 != None:
elementStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
elementStructure.baseStructureReference = p[1]
if p[0] == "tagName":
elementStructure.elementName = p[1]
if p[0] == "attributes":
elementStructure.attributes = p[1]
if p[0] == "allowedContent":
elementStructure.allowedContent = p[1]
if p[0] == "isSelfClosing":
elementStructure.isSelfClosing = p[1]
if p[0] == "lineBreaks":
elementStructure.lineBreaks = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
# If the element name has not been set explicitly, use the element structure reference.
# This allows .schema files to be terse.
if elementStructure.elementName == "":
elementStructure.elementName = elementStructure.reference
return elementStructure
def _parsePropertyStructure(self, inputText, marker, schema = None):
""" Gets any property structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
propertyStructure = PropertyStructure()
propertyStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
propertyStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
propertyStructure.metadata.description = m1.group(1).strip()
if m2 != None:
propertyStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "tagName":
propertyStructure.propertyName = p[1]
if p[0] == "valueType":
propertyStructure.valueTypeReference = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
# If the property name has not been set explicitly, use the property structure reference.
# This allows .schema files to be terse.
if propertyStructure.propertyName == "":
propertyStructure.propertyName = propertyStructure.reference
return propertyStructure
def _parseArrayStructure(self, inputText, marker, schema = None):
""" Gets any array structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
arrayStructure = ArrayStructure()
arrayStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
arrayStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
arrayStructure.metadata.description = m1.group(1).strip()
if m2 != None:
arrayStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
arrayStructure.baseStructureReference = p[1]
if p[0] == "itemType":
arrayStructure.itemTypeReference = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
return arrayStructure
def _parseObjectStructure(self, inputText, marker, schema = None):
""" Gets any object structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
objectStructure = ObjectStructure()
objectStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
objectStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
objectStructure.metadata.description = m1.group(1).strip()
if m2 != None:
objectStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
objectStructure.baseStructureReference = p[1]
if p[0] == "properties":
objectStructure.properties = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
return objectStructure
def _parseProperty(self, inputText, marker, schema = None):
""" Gets any property at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse structure property.")
self._parseWhiteSpace(inputText, marker)
# Get the property name.
propertyName = self._parsePropertyName(inputText, marker)
# If there is no property name, there is no property, so return None.
if propertyName == None:
return None
logger.debug(f"Found property name '{propertyName}'.")
# If the property name is not a Schemata property name, raise an exception.
if propertyName not in Parser._propertyNames:
raise SchemataParsingError(f"'{propertyName}' is not a valid Schemata property name.")
self._parseWhiteSpace(inputText, marker)
# A colon must follow for it to be a property.
if cut(inputText, marker.position) == ":":
marker.position += 1
else:
return None
self._parseWhiteSpace(inputText, marker)
propertyValue = None
# Get the property value. If the type of the property value is wrong, raise an exception.
if propertyName == "baseType":
propertyValue = self._parseReference(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a reference for property '{propertyName}'.")
if propertyName == "tagName":
propertyValue = self._parseString(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a string for property '{propertyName}'.")
if propertyName == "allowedPattern":
propertyValue = self._parseString(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a string for property '{propertyName}'.")
if propertyName == "allowedValues":
propertyValue = self._parseList(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a list of values for property '{propertyName}'.")
if propertyName == "minimumValue":
propertyValue = self._parseInteger(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected an integer for property '{propertyName}'.")
if propertyName == "maximumValue":
propertyValue = self._parseInteger(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected an integer for property '{propertyName}'.")
if propertyName == "defaultValue":
propertyValue = self._parseString(inputText, marker)
if propertyValue == None:
propertyValue = self._parseInteger(inputText, marker)
if propertyValue == None:
propertyValue = self._parseBoolean(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a string, integer, or boolean for property '{propertyName}'.")
if propertyName == "valueType":
propertyValue = self._parseListFunction(inputText, marker, schema)
if propertyValue == None:
propertyValue = self._parseReference(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a reference for property '{propertyName}'.")
if propertyName == "itemType":
propertyValue = self._parseReference(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a reference for property '{propertyName}'.")
if propertyName == "attributes":
propertyValue = self._parseList(inputText, marker, "attributeUsageReference", schema)
if propertyValue == None:
raise SchemataParsingError(f"Expected an attribute usage reference list for property '{propertyName}'.")
if propertyName == "properties":
propertyValue = self._parseList(inputText, marker, "propertyUsageReference", schema)
if propertyValue == None:
raise SchemataParsingError(f"Expected a property usage reference list for property '{propertyName}'.")
if propertyName == "allowedContent":
propertyValue = self._parseSubelementUsages(inputText, marker, schema)
if propertyValue == None:
raise SchemataParsingError(f"Expected a structure usage reference or structure list for property '{propertyName}'.")
if propertyName == "isSelfClosing":
propertyValue = self._parseBoolean(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a boolean for property '{propertyName}'.")
if propertyName == "lineBreaks":
propertyValue = self._parseList(inputText, marker, "integer")
if propertyValue == None:
raise SchemataParsingError(f"Expected a list of integers for property '{propertyName}'.")
if propertyValue == None:
raise SchemataParsingError(f"Expected a value for property '{propertyName}'.")
self._parseWhiteSpace(inputText, marker)
logger.debug("Found property value '{}'.".format(propertyValue))
# Expect semi-colon.
if cut(inputText, marker.position) == ";":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ';' at position {marker.position}.")
return (propertyName, propertyValue)
def _parseListFunction(self, inputText, marker, schema = None):
""" Gets any list function at the current position and returns it.
List functions can be used to automatically create new data types where the data structure is a list
of another data type's enumerations. This prevents the user from having to write complex patterns
in the .schema file.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse list function.")
self._parseWhiteSpace(inputText, marker)
# List functions must start with 'list'.
if cut(inputText, marker.position, 4) == "list":
marker.position += 4
else:
return None
self._parseWhiteSpace(inputText, marker)
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "(":
marker.position += 1
else:
raise SchemataParsingError(f"Expected '(' at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Expect a reference.
reference = self._parseReference(inputText, marker)
if reference == None:
raise SchemataParsingError(f"Expected a reference at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Expect a comma.
if cut(inputText, marker.position, 1) == ",":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ',' at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Expect a string that denotes the separator.
separator = self._parseString(inputText, marker)
if separator == None:
raise SchemataParsingError(f"Expected a string at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
listFunction = ListFunction(reference, separator)
listFunction.schema = schema
logger.debug(f"Found list function: {listFunction}.")
return listFunction
def _parseSubelementUsages(self, inputText, marker, schema = None):
""" Gets any subelement usage at the current position and returns it.
A subelement usage can include an element usage reference, a data usage reference, an any elements usage reference,
an any text usage reference, an ordered structure list, an unordered structure list, or a structure choice.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
# Look for the different things that can be subelement usages, and return if found.
item = self._parseElementUsageReference(inputText, marker, schema)
if item != None:
return item
logger.debug("Didn't find element usage reference.")
item = self._parseAnyElementsUsageReference(inputText, marker, schema)
if item != None:
return item
logger.debug("Didn't find any elements usage reference.")
item = self._parseAnyTextUsageReference(inputText, marker, schema)
if item != None:
return item
logger.debug("Didn't find any text usage reference.")
item = self._parseSubelementList(inputText, marker, schema)
if item != None:
return item
logging.debug("Didn't find subelement list.")
return None
def _parseSubelementList(self, inputText, marker, schema = None):
""" Gets any subelement / substructure list at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse a subelement list.")
# Copy the marker, as we're going to use other functions that will edit the marker.
m = marker.copy()
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
# The bracket type and the separator type determine what kind of list this is.
bracketType = ""
separatorType = "comma"
if cut(inputText, m.position) == "{":
bracketType = "recurve"
m.position += 1
elif cut(inputText, m.position) == "[":
bracketType = "square"
m.position += 1
else:
return None
logger.debug(f"Identified bracket type: {bracketType}.")
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
items = []
n = 0
# Step through the text looking for list items.
while m.position < len(inputText):
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
# There should be a separator character between each list item.
if n > 0:
c = cut(inputText, m.position)
# The first separator used sets up what separator to expect for the rest of the list.
if n == 1:
if c == ",":
separatorType = "comma"
m.position += 1
elif c == "/":
separatorType = "slash"
# Slashes can only be used with recurve brackets.
if bracketType == "square":
raise SchemataParsingError(f"Expected ',' at position {m.position}.")
m.position += 1
elif n > 1:
if (separatorType == "comma" and c == ",") or (separatorType == "slash" and c == "/"):
m.position += 1
elif (separatorType == "comma" and c == "/") or (separatorType == "slash" and c == ","):
# If the separator type is not consistent throughout the list, raise an exception.
raise SchemataParsingError(f"Separators must be the same throughout a list (position {m.position}).")
else:
break
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
# Try to get an item.
item = self._parseSubelementUsages(inputText, m, schema)
# If no item is found, break the loop.
if item == None:
break
items.append(item)
n += 1
logger.debug(f"Identified separator type: {separatorType}.")
logger.debug(f"List: {items}.")
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
# Check for closing bracket.
c = cut(inputText, m.position)
if bracketType == "recurve" and c == "}":
m.position += 1
elif bracketType == "square" and c == "]":
m.position += 1
else:
# If no closing bracket or the wrong closing bracket is found, raise an exception.
raise SchemataParsingError(f"Expected closing bracket at position {m.position}.")
# Make the list object.
if bracketType == "square" and separatorType == "comma":
l = OrderedStructureList()
l.schema = schema
l.structures = items
elif bracketType == "recurve" and separatorType == "comma":
l = UnorderedStructureList()
l.schema = schema
l.structures = items
elif bracketType == "recurve" and separatorType == "slash":
l = StructureChoice()
l.schema = schema
l.structures = items
else:
return None
logger.debug(f"Found subelement list {l}.")
# Update the original marker.
marker.position = m.position
return l
def _parseAttributeUsageReference(self, inputText, marker, schema = None):
""" Gets an attribute usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse attribute usage reference.")
# First get the reference.
self._parseWhiteSpace(inputText, marker)
attributeStructureReference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
if attributeStructureReference == None:
return None
attributeUsageReference = AttributeUsageReference()
attributeUsageReference.schema = schema
attributeUsageReference.attributeStructureReference = attributeStructureReference
# Get the information in brackets, if there is any.
if cut(inputText, marker.position) == "(":
marker.position += 1
self._parseWhiteSpace(inputText, marker)
# Work out if this is an optional attribute.
if cut(inputText, marker.position, 8) == "optional":
marker.position += 8
attributeUsageReference.isOptional = True
self._parseWhiteSpace(inputText, marker)
# If there's not a closing bracket, raise an exception.
if cut(inputText, marker.position) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
else:
# If there's nothing in the brackets, raise an exception.
raise SchemataParsingError(f"Expected keyword at position {marker.position}.")
return attributeUsageReference
def _parseElementUsageReference(self, inputText, marker, schema = None):
""" Gets an element usage reference at the current position and returns it.
This will also pick up data usage references, as the two are indistinguishable. Sorting the element usage
references from the data usage references is dealt with later in the parsing process.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse element usage reference.")
# First get the reference.
self._parseWhiteSpace(inputText, marker)
elementStructureReference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
if elementStructureReference == None:
return None
elementUsageReference = ElementUsageReference()
elementUsageReference.schema = schema
elementUsageReference.elementStructureReference = elementStructureReference
# Get the information in the brackets, if there is any.
if cut(inputText, marker.position) == "(":
marker.position += 1
self._parseWhiteSpace(inputText, marker)
elementUsageReference.minimumNumberOfOccurrences = 0
elementUsageReference.maximumNumberOfOccurrences = -1
nExpression = self._parseNExpression(inputText, marker)
if nExpression != None:
elementUsageReference.nExpression = nExpression
# If there's not a closing bracket, raise an exception.
if cut(inputText, marker.position) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
elif cut(inputText, marker.position, 8) == "optional":
marker.position += 8
elementUsageReference.nExpression = [(">=", 0), ("<=", 1)]
self._parseWhiteSpace(inputText, marker)
# If there's not a closing bracket, raise an exception.
if cut(inputText, marker.position) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
else:
# If there's nothing in the brackets, raise an exception.
raise SchemataParsingError(f"Expected expression or keyword at position {marker.position}.")
# Apply the n-expression.
if elementUsageReference.nExpression != None:
for comparison in elementUsageReference.nExpression:
if comparison[0] == ">=":
elementUsageReference.minimumNumberOfOccurrences = comparison[1]
if comparison[0] == ">":
elementUsageReference.minimumNumberOfOccurrences = comparison[1] + 1
if comparison[0] == "<=":
elementUsageReference.maximumNumberOfOccurrences = comparison[1]
if comparison[0] == "<":
elementUsageReference.maximumNumberOfOccurrences = comparison[1] - 1
if comparison[0] == "=":
elementUsageReference.minimumNumberOfOccurrences = comparison[1]
elementUsageReference.maximumNumberOfOccurrences = comparison[1]
return elementUsageReference
def _parsePropertyUsageReference(self, inputText, marker, schema = None):
""" Gets a property usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse property usage reference.")
# First get the reference.
self._parseWhiteSpace(inputText, marker)
propertyStructureReference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
if propertyStructureReference == None:
return None
propertyUsageReference = PropertyUsageReference()
propertyUsageReference.schema = schema
propertyUsageReference.propertyStructureReference = propertyStructureReference
# Get the information in brackets, if there is any.
if cut(inputText, marker.position) == "(":
marker.position += 1
self._parseWhiteSpace(inputText, marker)
# Work out if this is an optional attribute.
if cut(inputText, marker.position, 8) == "optional":
marker.position += 8
propertyUsageReference.isOptional = True
self._parseWhiteSpace(inputText, marker)
# If there's not a closing bracket, raise an exception.
if cut(inputText, marker.position) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
else:
# If there's nothing in the brackets, raise an exception.
raise SchemataParsingError(f"Expected keyword at position {marker.position}.")
return propertyUsageReference
def _parseAnyAttributesUsageReference(self, inputText, marker, schema = None):
""" Gets an any attributes usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
if cut(inputText, marker.position, 16) == "*any attributes*":
marker.position += 16
ur = AnyAttributesUsageReference()
ur.schema = schema
return schema
return None
def _parseAnyElementsUsageReference(self, inputText, marker, schema = None):
""" Gets an any elements usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
if cut(inputText, marker.position, 14) == "*any elements*":
marker.position += 14
ur = AnyElementsUsageReference()
ur.schema = schema
return ur
return None
def _parseAnyTextUsageReference(self, inputText, marker, schema = None):
""" Gets an any text usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
if cut(inputText, marker.position, 10) == "*any text*":
marker.position += 10
ur = AnyTextUsageReference()
ur.schema = schema
return ur
return None
def _parseAnyPropertiesUsageReference(self, inputText, marker, schema = None):
""" Gets an any properties usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
if cut(inputText, marker.position, 16) == "*any properties*":
marker.position += 16
ur = AnyPropertiesUsageReference()
ur.schema = schema
return schema
return None
def _parseNExpression(self, inputText, marker):
""" Gets any n-expression (an expression of the form 'n > 0' or '0 > n > 3') at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
logger.debug("Attempting to parse n-expression.")
# Start by trying to find something of the form '0 <'.
self._parseWhiteSpace(inputText, marker)
n1 = self._parseInteger(inputText, marker)
o1 = None
self._parseWhiteSpace(inputText, marker)
if n1 != None:
o1 = self._parseOperator(inputText, marker)
# If the expression starts with a number, an operator must follow.
if o1 == None:
raise SchemataParsingError(f"Expected an operator at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Check for the variable - 'n'.
if cut(inputText, marker.position) == "n":
marker.position += 1
else:
# If nothing has been found so far, then there is no n-expression, so return None.
# If a number and operator have been found, but not an 'n', then the syntax is wrong, so raise an exception.
if n1 == None and o1 == None:
return None
else:
raise SchemataParsingError(f"Expected 'n' at position {marker.position}.")
# Look for an operator and number after the 'n'.
self._parseWhiteSpace(inputText, marker)
o2 = self._parseOperator(inputText, marker)
if o2 == None:
raise SchemataParsingError(f"Expected an operator at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
n2 = self._parseInteger(inputText, marker)
if n2 == None:
raise SchemataParsingError(f"Expected a number at position {marker.position}.")
e = []
# Operators before the 'n' must be reversed.
if n1 != None and o1 != None:
i = self._operators.index(o1)
o1b = self._negatedOperators[i]
e += [(o1b, n1)]
e += [(o2, n2)]
return e
def _parseList(self, inputText, marker, objectType = "string", schema = None):
""" Gets any list (of strings, integers, booleans, et cetera) at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
objectType : str
The type of object to expect in the list
"""
logger.debug("Attempting to parse list.")
items = []
n = 0
# Keep trying to find items in the list until you find something that's not a valid list item.
while marker.position < len(inputText):
self._parseWhiteSpace(inputText, marker)
# Expect a comma between each of the items in the list.
if n > 0:
if cut(inputText, marker.position) == ",":
marker.position += 1
else:
break
self._parseWhiteSpace(inputText, marker)
item = None
# Check to see if the expected object is present.
if objectType == "string":
item = self._parseString(inputText, marker)
if objectType == "integer":
item = self._parseInteger(inputText, marker)
if objectType == "boolean":
item = self._parseBoolean(inputText, marker)
if objectType == "attributeUsageReference":
item = self._parseAttributeUsageReference(inputText, marker, schema)
if objectType == "propertyUsageReference":
item = self._parsePropertyUsageReference(inputText, marker, schema)
# If an item of the right type is not found, break the loop.
if item == None:
break
items.append(item)
n += 1
# If no items were found, no list was found, so return None.
if n == 0:
return None
logger.debug(f"Found list {items}.")
return items
# Parsing of basic structures starts here.
def _parsePropertyName(self, inputText, marker):
""" Gets any property name at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
logger.debug("Attempting to parse property name.")
t = ""
# Step through the text and check if the current character is a valid property name character.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
# If the current character is a valid property name character, add it to the temporary variable. Otherwise, break the loop.
if c in Parser._propertyNameCharacters:
t += c
marker.position += 1
else:
break
# If no property name was found, return None.
if len(t) == 0:
return None
logger.debug(f"Found property name '{t}'.")
return t
def _parseReference(self, inputText, marker):
""" Gets any reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
t = ""
# Step through the text to see if each character is a valid reference character.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
# If the current character is a valid reference character, add it to the temporary variable. Otherwise, break the loop.
if c in Parser._referenceCharacters:
t += c
marker.position += 1
else:
break
# If nothing was found, return None.
if len(t) == 0:
return None
logger.debug(f"Found reference '{t}'.")
return t
def _parseOperator(self, inputText, marker):
""" Gets any operator at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
# Sort the operators so that we check for the longest one first.
operators = sorted(self._operators, key= lambda o: len(o), reverse=True)
# Go through the list of operators.
for operator in operators:
# Check if the operator is at the current position.
if cut(inputText, marker.position, len(operator)) == operator:
marker.position += len(operator)
return operator
# If no operator is found, return None.
return None
def _parseString(self, inputText, marker):
""" Gets any string at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
t = ""
quoteMarkType = ""
foundClosingQuoteMark = False
# Strings in .schema files can start with either single or double quote marks. Check to see if the current character is either.
if cut(inputText, marker.position) == "'":
quoteMarkType = "single"
marker.position += 1
elif cut(inputText, marker.position) == "\"":
quoteMarkType = "double"
marker.position += 1
else:
# If the current character isn't a single or double quote mark, then there is no string, so return None.
return None
# Step through the text and look for the closing quote mark.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
# If the closing quote mark is found, exit the loop. Otherwise, add the character to the temporary variable.
if (quoteMarkType == "single" and c == "'") or (quoteMarkType == "double" and c == "\""):
marker.position += 1
foundClosingQuoteMark = True
break
else:
t += c
marker.position += 1
# If no closing quote mark is found, then the .schema file syntax is wrong, so raise an exception.
if not foundClosingQuoteMark:
quoteMark = "'" if quoteMarkType == "single" else "\""
raise SchemataParsingError(f"Expected {quoteMark} at position {marker.position}.")
return t
def _parseInteger(self, inputText, marker):
""" Gets any integer at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
t = ""
# Step through the text and check if the characters are digits.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
if c in "0123456789":
t += c
# If the current character is a digit, move the marker along by 1.
marker.position += 1
else:
break
# If no digits are found, return None.
if len(t) == 0:
return None
return int(t)
def _parseBoolean(self, inputText, marker):
""" Gets any boolean at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
# If either 'true' or 'false' is found, return a boolean value.
if cut(inputText, marker.position, 4) == "true":
marker.position += 4
return True
elif cut(inputText, marker.position, 5) == "false":
marker.position += 5
return False
# Otherwise return None.
return None
def _parseComment(self, inputText, marker):
""" Gets any comment at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
# Check for the opening comment token.
if cut(inputText, marker.position, 2) == "/*":
marker.position += 2
t = ""
foundClosingTag = False
# Step through the text and look for the closing comment token.
while marker.position < len(inputText):
if cut(inputText, marker.position, 2) == "*/":
marker.position += 2
foundClosingTag = True
break
else:
# Until the closing comment token is found, add any text to the temporary variable.
t += cut(inputText, marker.position)
marker.position += 1
# If no closing comment token is found, raise an exception.
if not foundClosingTag:
raise SchemataParsingError(f"Expected '*/' at position {marker.position}.")
return t
else:
# If no comment is found, return None.
return None
def _parseWhiteSpace(self, inputText, marker):
""" Gets any white space at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
t = ""
# Step through the text and check if it is white space.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
if c in " \t\n":
t += c
# If the current character is white space, move the marker along by 1.
marker.position += 1
else:
break
# If no white space is found, return None.
if len(t) == 0:
return None
return t
|
schematacode
|
/schematacode-1.0.1.tar.gz/schematacode-1.0.1/schemata/parser.py
|
parser.py
|
import os
import logging
import re
from lxml.etree import ElementTree as XMLElementTree, Element as XMLElement, SubElement as XMLSubelement, Comment as XMLComment, QName, indent
import json
from schemata.structures import *
logger = logging.getLogger("schemata.parser")
"""
This module contains the Schemata parser.
This module contains the code that takes Schemata syntax - a relatively compact syntax - and turns it into
a set of objects representing the schema. From there, the schema can be exported to XSD, or Schematron, or
JSON Schemas, or auto-generated documentation, depending on what's relevant.
The parsing is done completely in one step. The parser scans the document and constructs the objects in one go.
"""
class Marker(object):
def __init__(self):
self.position = 0
def copy(self):
marker = Marker()
marker.position = self.position
return marker
def cut(text, startIndex, length=1):
a = startIndex
b = startIndex + length
return text[a:b]
class SchemataParsingError(Exception):
def __init__(self, message):
super().__init__(message)
class Parser(object):
_propertyNameCharacters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-"
_referenceCharacters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-"
_operators = ["=", ">", ">=", "<", "<=", "/="]
_negatedOperators = ["=", "<", "<=", ">", ">=", "/="]
_propertyNames = [
"baseType",
"tagName",
"allowedPattern",
"allowedValues",
"minimumValue",
"maximumValue",
"defaultValue",
"valueType",
"attributes",
"allowedContent",
"itemType",
"properties",
"isSelfClosing",
"lineBreaks"
]
def __init__(self):
pass
def parseSchemaFromFile(self, filePath):
with open(filePath, "r") as fileObject:
text = fileObject.read()
schema = self.parseSchema(text, filePath)
return schema
def parseSchema(self, inputText, filePath = ""):
logger.debug("Attempting to parse schema.")
marker = Marker()
schema = Schema()
self._parseWhiteSpace(inputText, marker)
logger.debug("Attempting to parse schema metadata.")
metadata = self._parseComment(inputText, marker)
if metadata != None:
logger.debug("Found metadata comment.")
m = re.search(r"Format Name:\s*(.+)\n", metadata)
if m != None:
schema.formatName = m.group(1).strip()
logger.debug(f"Got format name '{schema.formatName}'.")
importStatements = self._parseImportStatements(inputText, marker, schema)
for i in importStatements:
path = os.path.join(os.path.dirname(filePath), i)
if not os.path.exists(path):
raise Exception(f"'{path}' does not exist.")
s = self.parseSchemaFromFile(path)
schema.dependencies.append(s)
schema.structures = self._parseStructures(inputText, marker, schema)
for structure in schema.structures:
if isinstance(structure, ElementStructure) and isinstance(structure.allowedContent, ElementUsageReference):
s = structure.allowedContent.elementStructure
if isinstance(s, DataStructure):
structure.valueTypeReference = s.reference
ds = DataUsageReference()
ds.schema = schema
ds.dataStructureReference = s.reference
structure.allowedContent =ds
listDataStructures = []
for structure in schema.structures:
if isinstance(structure, AttributeStructure) and isinstance(structure.dataStructureReference, ListFunction):
lf = structure.dataStructureReference
ds1 = lf.dataStructure
ds1.setIsUsed()
pattern = ""
if ds1.allowedValues:
pattern = "|".join(ds1.allowedValues)
elif ds1.allowedPattern != "":
pattern = ds1.allowedPattern
ds2 = DataStructure()
ds2.schema = schema
ds2.reference = f"list_of__{ds1.reference}"
ds2.baseStructureReference = "string"
ds2.allowedPattern = "({})(\s*{}\s*({}))*".format(pattern, lf.separator, pattern)
logger.debug("Creating list structure '{}'.".format(ds2.reference))
structure.dataStructureReference = ds2.reference
listDataStructures.append(ds2)
logger.debug(f"Created {len(listDataStructures)} list data structures.")
schema.structures += listDataStructures
schema.setIsUsed()
logger.debug("Schema structures: {}".format(", ".join([str(structure) for structure in schema.structures])))
return schema
def _parseImportStatements(self, inputText, marker, schema = None):
logger.debug("Getting import statements.")
self._parseWhiteSpace(inputText, marker)
importStatements = []
while marker.position < len(inputText):
i = self._parseImportStatement(inputText, marker, schema)
if i != None:
importStatements.append(i)
else:
break
logger.debug(f"{len(importStatements)} import statements found.")
return importStatements
def _parseImportStatement(self, inputText, marker, schema = None):
logger.debug("Attempting to parse import statement.")
self._parseWhiteSpace(inputText, marker)
if cut(inputText, marker.position, 6) == "import":
marker.position += 6
self._parseWhiteSpace(inputText, marker)
path = self._parseString(inputText, marker)
if path == None or path == "":
raise SchemataParsingError(f"Expected a path string at {marker.position}.")
logger.debug(f"Found path '{path}'.")
return path
return None
def _parseStructures(self, inputText, marker, schema = None):
logger.debug("Attempting to parse structures.")
structures = []
references = []
while marker.position < len(inputText):
self._parseWhiteSpace(inputText, marker)
self._parseComment(inputText, marker)
structure = self._parseStructure(inputText, marker, schema)
if structure != None:
if structure.reference in references:
raise SchemataParsingError(f"A structure with the reference '{structure.reference}' has already been defined.")
structures.append(structure)
references.append(structure.reference)
logger.debug(f"Found {len(structures)} structures.")
return structures
def _parseStructure(self, inputText, marker, schema = None):
logger.debug("Attempting to parse structure.")
self._parseWhiteSpace(inputText, marker)
if cut(inputText, marker.position, 8) == "dataType":
marker.position += 8
logger.debug("Found data structure.")
dataStructure = self._parseDataStructure(inputText, marker, schema)
return dataStructure
if cut(inputText, marker.position, 9) == "attribute":
marker.position += 9
logger.debug("Found attribute structure.")
attributeStructure = self._parseAttributeStructure(inputText, marker, schema)
return attributeStructure
if cut(inputText, marker.position, 4) == "root":
marker.position += 4
self._parseWhiteSpace(inputText, marker)
if cut(inputText, marker.position, 7) == "element":
marker.position += 7
logger.debug("Found root element structure.")
elementStructure = self._parseElementStructure(inputText, marker, schema)
elementStructure.canBeRootElement = True
return elementStructure
elif cut(inputText, marker.position, 6) == "object":
marker.position += 6
logger.debug("Found root object structure.")
objectStructure = self._parseObjectStructure(inputText, marker, schema)
objectStructure.canBeRootObject = True
return objectStructure
else:
raise SchemataParsingError(f"Expected 'element' keyword at position {marker.position}.")
if cut(inputText, marker.position, 7) == "element":
marker.position += 7
logger.debug("Found element structure.")
elementStructure = self._parseElementStructure(inputText, marker, schema)
return elementStructure
if cut(inputText, marker.position, 8) == "property":
marker.position += 8
logger.debug("Found property structure.")
propertyStructure = self._parsePropertyStructure(inputText, marker, schema)
return propertyStructure
if cut(inputText, marker.position, 5) == "array":
marker.position += 5
logger.debug("Found array structure.")
arrayStructure = self._parseArrayStructure(inputText, marker, schema)
return arrayStructure
if cut(inputText, marker.position, 6) == "object":
marker.position += 6
logger.debug("Found object structure.")
objectStructure = self._parseObjectStructure(inputText, marker, schema)
return objectStructure
return None
def _parseDataStructure(self, inputText, marker, schema = None):
""" Gets any data structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
dataStructure = DataStructure()
dataStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
dataStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
dataStructure.metadata.description = m1.group(1).strip()
if m2 != None:
dataStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
dataStructure.baseStructureReference = p[1]
if p[0] == "allowedPattern":
dataStructure.allowedPattern = p[1]
if p[0] == "allowedValues":
dataStructure.allowedValues = p[1]
if p[0] == "minimumValue":
dataStructure.minimumValue = p[1]
if p[0] == "maximumValue":
dataStructure.maximumValue = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
return dataStructure
def _parseAttributeStructure(self, inputText, marker, schema = None):
""" Gets any attribute structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
attributeStructure = AttributeStructure()
attributeStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
attributeStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
attributeStructure.metadata.description = m1.group(1).strip()
if m2 != None:
attributeStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
attributeStructure.baseStructureReference = p[1]
if p[0] == "tagName":
attributeStructure.attributeName = p[1]
if p[0] == "valueType":
attributeStructure.dataStructureReference = p[1]
if p[0] == "defaultValue":
attributeStructure.defaultValue = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
# If the attribute name has not been set explicitly, use the attribute structure reference.
# This allows .schema files to be terse.
if attributeStructure.attributeName == "":
attributeStructure.attributeName = attributeStructure.reference
return attributeStructure
def _parseElementStructure(self, inputText, marker, schema = None):
""" Gets any element structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
elementStructure = ElementStructure()
elementStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
elementStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
elementStructure.metadata.description = m1.group(1).strip()
if m2 != None:
elementStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
elementStructure.baseStructureReference = p[1]
if p[0] == "tagName":
elementStructure.elementName = p[1]
if p[0] == "attributes":
elementStructure.attributes = p[1]
if p[0] == "allowedContent":
elementStructure.allowedContent = p[1]
if p[0] == "isSelfClosing":
elementStructure.isSelfClosing = p[1]
if p[0] == "lineBreaks":
elementStructure.lineBreaks = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
# If the element name has not been set explicitly, use the element structure reference.
# This allows .schema files to be terse.
if elementStructure.elementName == "":
elementStructure.elementName = elementStructure.reference
return elementStructure
def _parsePropertyStructure(self, inputText, marker, schema = None):
""" Gets any property structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
propertyStructure = PropertyStructure()
propertyStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
propertyStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
propertyStructure.metadata.description = m1.group(1).strip()
if m2 != None:
propertyStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "tagName":
propertyStructure.propertyName = p[1]
if p[0] == "valueType":
propertyStructure.valueTypeReference = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
# If the property name has not been set explicitly, use the property structure reference.
# This allows .schema files to be terse.
if propertyStructure.propertyName == "":
propertyStructure.propertyName = propertyStructure.reference
return propertyStructure
def _parseArrayStructure(self, inputText, marker, schema = None):
""" Gets any array structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
arrayStructure = ArrayStructure()
arrayStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
arrayStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
arrayStructure.metadata.description = m1.group(1).strip()
if m2 != None:
arrayStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
arrayStructure.baseStructureReference = p[1]
if p[0] == "itemType":
arrayStructure.itemTypeReference = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
return arrayStructure
def _parseObjectStructure(self, inputText, marker, schema = None):
""" Gets any object structure at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
objectStructure = ObjectStructure()
objectStructure.schema = schema
# Get the reference.
self._parseWhiteSpace(inputText, marker)
reference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
objectStructure.reference = reference
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "{":
marker.position += 1
else:
raise SchemataParsingError("Expected '{{' at position {}.".format(marker.position))
self._parseWhiteSpace(inputText, marker)
# Get the metadata.
metadata = self._parseComment(inputText, marker)
if metadata != None:
m1 = re.search(r"Description:\s*(.+)\n", metadata)
m2 = re.search(r"Example Value:\s*(.+)\n", metadata)
if m1 != None:
objectStructure.metadata.description = m1.group(1).strip()
if m2 != None:
objectStructure.metadata.exampleValue = m2.group(1).strip()
self._parseWhiteSpace(inputText, marker)
# Step through the text looking for properties.
while marker.position < len(inputText):
p = self._parseProperty(inputText, marker, schema)
if p == None:
break
else:
if p[0] == "baseType":
objectStructure.baseStructureReference = p[1]
if p[0] == "properties":
objectStructure.properties = p[1]
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == "}":
marker.position += 1
else:
raise SchemataParsingError("Expected '}}' at position {}.".format(marker.position))
return objectStructure
def _parseProperty(self, inputText, marker, schema = None):
""" Gets any property at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse structure property.")
self._parseWhiteSpace(inputText, marker)
# Get the property name.
propertyName = self._parsePropertyName(inputText, marker)
# If there is no property name, there is no property, so return None.
if propertyName == None:
return None
logger.debug(f"Found property name '{propertyName}'.")
# If the property name is not a Schemata property name, raise an exception.
if propertyName not in Parser._propertyNames:
raise SchemataParsingError(f"'{propertyName}' is not a valid Schemata property name.")
self._parseWhiteSpace(inputText, marker)
# A colon must follow for it to be a property.
if cut(inputText, marker.position) == ":":
marker.position += 1
else:
return None
self._parseWhiteSpace(inputText, marker)
propertyValue = None
# Get the property value. If the type of the property value is wrong, raise an exception.
if propertyName == "baseType":
propertyValue = self._parseReference(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a reference for property '{propertyName}'.")
if propertyName == "tagName":
propertyValue = self._parseString(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a string for property '{propertyName}'.")
if propertyName == "allowedPattern":
propertyValue = self._parseString(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a string for property '{propertyName}'.")
if propertyName == "allowedValues":
propertyValue = self._parseList(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a list of values for property '{propertyName}'.")
if propertyName == "minimumValue":
propertyValue = self._parseInteger(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected an integer for property '{propertyName}'.")
if propertyName == "maximumValue":
propertyValue = self._parseInteger(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected an integer for property '{propertyName}'.")
if propertyName == "defaultValue":
propertyValue = self._parseString(inputText, marker)
if propertyValue == None:
propertyValue = self._parseInteger(inputText, marker)
if propertyValue == None:
propertyValue = self._parseBoolean(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a string, integer, or boolean for property '{propertyName}'.")
if propertyName == "valueType":
propertyValue = self._parseListFunction(inputText, marker, schema)
if propertyValue == None:
propertyValue = self._parseReference(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a reference for property '{propertyName}'.")
if propertyName == "itemType":
propertyValue = self._parseReference(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a reference for property '{propertyName}'.")
if propertyName == "attributes":
propertyValue = self._parseList(inputText, marker, "attributeUsageReference", schema)
if propertyValue == None:
raise SchemataParsingError(f"Expected an attribute usage reference list for property '{propertyName}'.")
if propertyName == "properties":
propertyValue = self._parseList(inputText, marker, "propertyUsageReference", schema)
if propertyValue == None:
raise SchemataParsingError(f"Expected a property usage reference list for property '{propertyName}'.")
if propertyName == "allowedContent":
propertyValue = self._parseSubelementUsages(inputText, marker, schema)
if propertyValue == None:
raise SchemataParsingError(f"Expected a structure usage reference or structure list for property '{propertyName}'.")
if propertyName == "isSelfClosing":
propertyValue = self._parseBoolean(inputText, marker)
if propertyValue == None:
raise SchemataParsingError(f"Expected a boolean for property '{propertyName}'.")
if propertyName == "lineBreaks":
propertyValue = self._parseList(inputText, marker, "integer")
if propertyValue == None:
raise SchemataParsingError(f"Expected a list of integers for property '{propertyName}'.")
if propertyValue == None:
raise SchemataParsingError(f"Expected a value for property '{propertyName}'.")
self._parseWhiteSpace(inputText, marker)
logger.debug("Found property value '{}'.".format(propertyValue))
# Expect semi-colon.
if cut(inputText, marker.position) == ";":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ';' at position {marker.position}.")
return (propertyName, propertyValue)
def _parseListFunction(self, inputText, marker, schema = None):
""" Gets any list function at the current position and returns it.
List functions can be used to automatically create new data types where the data structure is a list
of another data type's enumerations. This prevents the user from having to write complex patterns
in the .schema file.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse list function.")
self._parseWhiteSpace(inputText, marker)
# List functions must start with 'list'.
if cut(inputText, marker.position, 4) == "list":
marker.position += 4
else:
return None
self._parseWhiteSpace(inputText, marker)
# Expect the opening bracket.
if cut(inputText, marker.position, 1) == "(":
marker.position += 1
else:
raise SchemataParsingError(f"Expected '(' at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Expect a reference.
reference = self._parseReference(inputText, marker)
if reference == None:
raise SchemataParsingError(f"Expected a reference at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Expect a comma.
if cut(inputText, marker.position, 1) == ",":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ',' at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Expect a string that denotes the separator.
separator = self._parseString(inputText, marker)
if separator == None:
raise SchemataParsingError(f"Expected a string at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Expect the closing bracket.
if cut(inputText, marker.position, 1) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
listFunction = ListFunction(reference, separator)
listFunction.schema = schema
logger.debug(f"Found list function: {listFunction}.")
return listFunction
def _parseSubelementUsages(self, inputText, marker, schema = None):
""" Gets any subelement usage at the current position and returns it.
A subelement usage can include an element usage reference, a data usage reference, an any elements usage reference,
an any text usage reference, an ordered structure list, an unordered structure list, or a structure choice.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
# Look for the different things that can be subelement usages, and return if found.
item = self._parseElementUsageReference(inputText, marker, schema)
if item != None:
return item
logger.debug("Didn't find element usage reference.")
item = self._parseAnyElementsUsageReference(inputText, marker, schema)
if item != None:
return item
logger.debug("Didn't find any elements usage reference.")
item = self._parseAnyTextUsageReference(inputText, marker, schema)
if item != None:
return item
logger.debug("Didn't find any text usage reference.")
item = self._parseSubelementList(inputText, marker, schema)
if item != None:
return item
logging.debug("Didn't find subelement list.")
return None
def _parseSubelementList(self, inputText, marker, schema = None):
""" Gets any subelement / substructure list at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse a subelement list.")
# Copy the marker, as we're going to use other functions that will edit the marker.
m = marker.copy()
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
# The bracket type and the separator type determine what kind of list this is.
bracketType = ""
separatorType = "comma"
if cut(inputText, m.position) == "{":
bracketType = "recurve"
m.position += 1
elif cut(inputText, m.position) == "[":
bracketType = "square"
m.position += 1
else:
return None
logger.debug(f"Identified bracket type: {bracketType}.")
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
items = []
n = 0
# Step through the text looking for list items.
while m.position < len(inputText):
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
# There should be a separator character between each list item.
if n > 0:
c = cut(inputText, m.position)
# The first separator used sets up what separator to expect for the rest of the list.
if n == 1:
if c == ",":
separatorType = "comma"
m.position += 1
elif c == "/":
separatorType = "slash"
# Slashes can only be used with recurve brackets.
if bracketType == "square":
raise SchemataParsingError(f"Expected ',' at position {m.position}.")
m.position += 1
elif n > 1:
if (separatorType == "comma" and c == ",") or (separatorType == "slash" and c == "/"):
m.position += 1
elif (separatorType == "comma" and c == "/") or (separatorType == "slash" and c == ","):
# If the separator type is not consistent throughout the list, raise an exception.
raise SchemataParsingError(f"Separators must be the same throughout a list (position {m.position}).")
else:
break
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
# Try to get an item.
item = self._parseSubelementUsages(inputText, m, schema)
# If no item is found, break the loop.
if item == None:
break
items.append(item)
n += 1
logger.debug(f"Identified separator type: {separatorType}.")
logger.debug(f"List: {items}.")
self._parseWhiteSpace(inputText, m)
self._parseComment(inputText, m)
self._parseWhiteSpace(inputText, m)
# Check for closing bracket.
c = cut(inputText, m.position)
if bracketType == "recurve" and c == "}":
m.position += 1
elif bracketType == "square" and c == "]":
m.position += 1
else:
# If no closing bracket or the wrong closing bracket is found, raise an exception.
raise SchemataParsingError(f"Expected closing bracket at position {m.position}.")
# Make the list object.
if bracketType == "square" and separatorType == "comma":
l = OrderedStructureList()
l.schema = schema
l.structures = items
elif bracketType == "recurve" and separatorType == "comma":
l = UnorderedStructureList()
l.schema = schema
l.structures = items
elif bracketType == "recurve" and separatorType == "slash":
l = StructureChoice()
l.schema = schema
l.structures = items
else:
return None
logger.debug(f"Found subelement list {l}.")
# Update the original marker.
marker.position = m.position
return l
def _parseAttributeUsageReference(self, inputText, marker, schema = None):
""" Gets an attribute usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse attribute usage reference.")
# First get the reference.
self._parseWhiteSpace(inputText, marker)
attributeStructureReference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
if attributeStructureReference == None:
return None
attributeUsageReference = AttributeUsageReference()
attributeUsageReference.schema = schema
attributeUsageReference.attributeStructureReference = attributeStructureReference
# Get the information in brackets, if there is any.
if cut(inputText, marker.position) == "(":
marker.position += 1
self._parseWhiteSpace(inputText, marker)
# Work out if this is an optional attribute.
if cut(inputText, marker.position, 8) == "optional":
marker.position += 8
attributeUsageReference.isOptional = True
self._parseWhiteSpace(inputText, marker)
# If there's not a closing bracket, raise an exception.
if cut(inputText, marker.position) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
else:
# If there's nothing in the brackets, raise an exception.
raise SchemataParsingError(f"Expected keyword at position {marker.position}.")
return attributeUsageReference
def _parseElementUsageReference(self, inputText, marker, schema = None):
""" Gets an element usage reference at the current position and returns it.
This will also pick up data usage references, as the two are indistinguishable. Sorting the element usage
references from the data usage references is dealt with later in the parsing process.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse element usage reference.")
# First get the reference.
self._parseWhiteSpace(inputText, marker)
elementStructureReference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
if elementStructureReference == None:
return None
elementUsageReference = ElementUsageReference()
elementUsageReference.schema = schema
elementUsageReference.elementStructureReference = elementStructureReference
# Get the information in the brackets, if there is any.
if cut(inputText, marker.position) == "(":
marker.position += 1
self._parseWhiteSpace(inputText, marker)
elementUsageReference.minimumNumberOfOccurrences = 0
elementUsageReference.maximumNumberOfOccurrences = -1
nExpression = self._parseNExpression(inputText, marker)
if nExpression != None:
elementUsageReference.nExpression = nExpression
# If there's not a closing bracket, raise an exception.
if cut(inputText, marker.position) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
elif cut(inputText, marker.position, 8) == "optional":
marker.position += 8
elementUsageReference.nExpression = [(">=", 0), ("<=", 1)]
self._parseWhiteSpace(inputText, marker)
# If there's not a closing bracket, raise an exception.
if cut(inputText, marker.position) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
else:
# If there's nothing in the brackets, raise an exception.
raise SchemataParsingError(f"Expected expression or keyword at position {marker.position}.")
# Apply the n-expression.
if elementUsageReference.nExpression != None:
for comparison in elementUsageReference.nExpression:
if comparison[0] == ">=":
elementUsageReference.minimumNumberOfOccurrences = comparison[1]
if comparison[0] == ">":
elementUsageReference.minimumNumberOfOccurrences = comparison[1] + 1
if comparison[0] == "<=":
elementUsageReference.maximumNumberOfOccurrences = comparison[1]
if comparison[0] == "<":
elementUsageReference.maximumNumberOfOccurrences = comparison[1] - 1
if comparison[0] == "=":
elementUsageReference.minimumNumberOfOccurrences = comparison[1]
elementUsageReference.maximumNumberOfOccurrences = comparison[1]
return elementUsageReference
def _parsePropertyUsageReference(self, inputText, marker, schema = None):
""" Gets a property usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
logger.debug("Attempting to parse property usage reference.")
# First get the reference.
self._parseWhiteSpace(inputText, marker)
propertyStructureReference = self._parseReference(inputText, marker)
self._parseWhiteSpace(inputText, marker)
if propertyStructureReference == None:
return None
propertyUsageReference = PropertyUsageReference()
propertyUsageReference.schema = schema
propertyUsageReference.propertyStructureReference = propertyStructureReference
# Get the information in brackets, if there is any.
if cut(inputText, marker.position) == "(":
marker.position += 1
self._parseWhiteSpace(inputText, marker)
# Work out if this is an optional attribute.
if cut(inputText, marker.position, 8) == "optional":
marker.position += 8
propertyUsageReference.isOptional = True
self._parseWhiteSpace(inputText, marker)
# If there's not a closing bracket, raise an exception.
if cut(inputText, marker.position) == ")":
marker.position += 1
else:
raise SchemataParsingError(f"Expected ')' at position {marker.position}.")
else:
# If there's nothing in the brackets, raise an exception.
raise SchemataParsingError(f"Expected keyword at position {marker.position}.")
return propertyUsageReference
def _parseAnyAttributesUsageReference(self, inputText, marker, schema = None):
""" Gets an any attributes usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
if cut(inputText, marker.position, 16) == "*any attributes*":
marker.position += 16
ur = AnyAttributesUsageReference()
ur.schema = schema
return schema
return None
def _parseAnyElementsUsageReference(self, inputText, marker, schema = None):
""" Gets an any elements usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
if cut(inputText, marker.position, 14) == "*any elements*":
marker.position += 14
ur = AnyElementsUsageReference()
ur.schema = schema
return ur
return None
def _parseAnyTextUsageReference(self, inputText, marker, schema = None):
""" Gets an any text usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
if cut(inputText, marker.position, 10) == "*any text*":
marker.position += 10
ur = AnyTextUsageReference()
ur.schema = schema
return ur
return None
def _parseAnyPropertiesUsageReference(self, inputText, marker, schema = None):
""" Gets an any properties usage reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
schema : Schema
The schema object being created
"""
if cut(inputText, marker.position, 16) == "*any properties*":
marker.position += 16
ur = AnyPropertiesUsageReference()
ur.schema = schema
return schema
return None
def _parseNExpression(self, inputText, marker):
""" Gets any n-expression (an expression of the form 'n > 0' or '0 > n > 3') at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
logger.debug("Attempting to parse n-expression.")
# Start by trying to find something of the form '0 <'.
self._parseWhiteSpace(inputText, marker)
n1 = self._parseInteger(inputText, marker)
o1 = None
self._parseWhiteSpace(inputText, marker)
if n1 != None:
o1 = self._parseOperator(inputText, marker)
# If the expression starts with a number, an operator must follow.
if o1 == None:
raise SchemataParsingError(f"Expected an operator at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
# Check for the variable - 'n'.
if cut(inputText, marker.position) == "n":
marker.position += 1
else:
# If nothing has been found so far, then there is no n-expression, so return None.
# If a number and operator have been found, but not an 'n', then the syntax is wrong, so raise an exception.
if n1 == None and o1 == None:
return None
else:
raise SchemataParsingError(f"Expected 'n' at position {marker.position}.")
# Look for an operator and number after the 'n'.
self._parseWhiteSpace(inputText, marker)
o2 = self._parseOperator(inputText, marker)
if o2 == None:
raise SchemataParsingError(f"Expected an operator at position {marker.position}.")
self._parseWhiteSpace(inputText, marker)
n2 = self._parseInteger(inputText, marker)
if n2 == None:
raise SchemataParsingError(f"Expected a number at position {marker.position}.")
e = []
# Operators before the 'n' must be reversed.
if n1 != None and o1 != None:
i = self._operators.index(o1)
o1b = self._negatedOperators[i]
e += [(o1b, n1)]
e += [(o2, n2)]
return e
def _parseList(self, inputText, marker, objectType = "string", schema = None):
""" Gets any list (of strings, integers, booleans, et cetera) at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
objectType : str
The type of object to expect in the list
"""
logger.debug("Attempting to parse list.")
items = []
n = 0
# Keep trying to find items in the list until you find something that's not a valid list item.
while marker.position < len(inputText):
self._parseWhiteSpace(inputText, marker)
# Expect a comma between each of the items in the list.
if n > 0:
if cut(inputText, marker.position) == ",":
marker.position += 1
else:
break
self._parseWhiteSpace(inputText, marker)
item = None
# Check to see if the expected object is present.
if objectType == "string":
item = self._parseString(inputText, marker)
if objectType == "integer":
item = self._parseInteger(inputText, marker)
if objectType == "boolean":
item = self._parseBoolean(inputText, marker)
if objectType == "attributeUsageReference":
item = self._parseAttributeUsageReference(inputText, marker, schema)
if objectType == "propertyUsageReference":
item = self._parsePropertyUsageReference(inputText, marker, schema)
# If an item of the right type is not found, break the loop.
if item == None:
break
items.append(item)
n += 1
# If no items were found, no list was found, so return None.
if n == 0:
return None
logger.debug(f"Found list {items}.")
return items
# Parsing of basic structures starts here.
def _parsePropertyName(self, inputText, marker):
""" Gets any property name at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
logger.debug("Attempting to parse property name.")
t = ""
# Step through the text and check if the current character is a valid property name character.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
# If the current character is a valid property name character, add it to the temporary variable. Otherwise, break the loop.
if c in Parser._propertyNameCharacters:
t += c
marker.position += 1
else:
break
# If no property name was found, return None.
if len(t) == 0:
return None
logger.debug(f"Found property name '{t}'.")
return t
def _parseReference(self, inputText, marker):
""" Gets any reference at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
t = ""
# Step through the text to see if each character is a valid reference character.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
# If the current character is a valid reference character, add it to the temporary variable. Otherwise, break the loop.
if c in Parser._referenceCharacters:
t += c
marker.position += 1
else:
break
# If nothing was found, return None.
if len(t) == 0:
return None
logger.debug(f"Found reference '{t}'.")
return t
def _parseOperator(self, inputText, marker):
""" Gets any operator at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
# Sort the operators so that we check for the longest one first.
operators = sorted(self._operators, key= lambda o: len(o), reverse=True)
# Go through the list of operators.
for operator in operators:
# Check if the operator is at the current position.
if cut(inputText, marker.position, len(operator)) == operator:
marker.position += len(operator)
return operator
# If no operator is found, return None.
return None
def _parseString(self, inputText, marker):
""" Gets any string at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
t = ""
quoteMarkType = ""
foundClosingQuoteMark = False
# Strings in .schema files can start with either single or double quote marks. Check to see if the current character is either.
if cut(inputText, marker.position) == "'":
quoteMarkType = "single"
marker.position += 1
elif cut(inputText, marker.position) == "\"":
quoteMarkType = "double"
marker.position += 1
else:
# If the current character isn't a single or double quote mark, then there is no string, so return None.
return None
# Step through the text and look for the closing quote mark.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
# If the closing quote mark is found, exit the loop. Otherwise, add the character to the temporary variable.
if (quoteMarkType == "single" and c == "'") or (quoteMarkType == "double" and c == "\""):
marker.position += 1
foundClosingQuoteMark = True
break
else:
t += c
marker.position += 1
# If no closing quote mark is found, then the .schema file syntax is wrong, so raise an exception.
if not foundClosingQuoteMark:
quoteMark = "'" if quoteMarkType == "single" else "\""
raise SchemataParsingError(f"Expected {quoteMark} at position {marker.position}.")
return t
def _parseInteger(self, inputText, marker):
""" Gets any integer at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
t = ""
# Step through the text and check if the characters are digits.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
if c in "0123456789":
t += c
# If the current character is a digit, move the marker along by 1.
marker.position += 1
else:
break
# If no digits are found, return None.
if len(t) == 0:
return None
return int(t)
def _parseBoolean(self, inputText, marker):
""" Gets any boolean at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
# If either 'true' or 'false' is found, return a boolean value.
if cut(inputText, marker.position, 4) == "true":
marker.position += 4
return True
elif cut(inputText, marker.position, 5) == "false":
marker.position += 5
return False
# Otherwise return None.
return None
def _parseComment(self, inputText, marker):
""" Gets any comment at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
# Check for the opening comment token.
if cut(inputText, marker.position, 2) == "/*":
marker.position += 2
t = ""
foundClosingTag = False
# Step through the text and look for the closing comment token.
while marker.position < len(inputText):
if cut(inputText, marker.position, 2) == "*/":
marker.position += 2
foundClosingTag = True
break
else:
# Until the closing comment token is found, add any text to the temporary variable.
t += cut(inputText, marker.position)
marker.position += 1
# If no closing comment token is found, raise an exception.
if not foundClosingTag:
raise SchemataParsingError(f"Expected '*/' at position {marker.position}.")
return t
else:
# If no comment is found, return None.
return None
def _parseWhiteSpace(self, inputText, marker):
""" Gets any white space at the current position and returns it.
Parameters
----------
inputText : str
The text being parsed
marker : Marker
A marker denoting the position at which to start parsing
"""
t = ""
# Step through the text and check if it is white space.
while marker.position < len(inputText):
c = cut(inputText, marker.position)
if c in " \t\n":
t += c
# If the current character is white space, move the marker along by 1.
marker.position += 1
else:
break
# If no white space is found, return None.
if len(t) == 0:
return None
return t
| 0.567577 | 0.254868 |
schematax
=========
|PyPI version| |License| |Supported Python| |Format| |Downloads|
schematax is a simple Python package to do all things related to schemata_.
A schema is word made using an extra symbol, '*', called the wild card symbol.
For example the schema over the binary aplhapbet '1*0', represents the set of
strings. {'100','110'}'.
Schema have properties. For example, for a schema s, the order of s is the
number of symbols in s which are not the wild card symbols (called fixed symbols).
The defining length of s is the distance between the first and last fixed symbol.
Given a set of words of the same length S, the schematic completion of S
returns all schema which make subsets of the words in S.
Whats more given the partial ordering over schemata, the schematic completion of S
forms a `Complete Lattice`_.
Links
-----
- GitHub:https://github.com/iSTB/python-schemata
- PyPI: http://pypi.python.org/pypi/schematax
- Issue Tracker: https://github.com/iSTB/python-schemata/issues
- Download: http://pypi.python.org/pypi/schematax#downloads
Installation
------------
This package runs under Python 2.7, use pip_ to install:
.. code:: bash
$ pip install schematax
This will also install the graphviz_ package from PyPI as
required dependencies.
**Important**: Drawing the the schematic lattice uses `Graphviz software`_. Make sure it
is installed and ``dot`` executable is on your systems' path.
Quickstart
----------
The file example.py gives a good overview of how to use the package.
Basic schema operations:
.. code-block:: python
>>> import schematax
>>> s = schematax.schema('10*1') #makes a schema
>>> s
10*1
>>> s.get_order()
3
>>> s.get_defining_length()
3
>>> s2 = schematax.schema('1**1') #makes another schema
>>> s <= s2
True
>>> s < s2
True
>>> s == s2
False
>>> schematax.meet(s,s2)
10*1
>>> schematax.join(s,s2)
1**1
>>> s3 = schematax.schema('00*1')
>>> schematax.supremum([s,s2,s3])
***1
>>> schematax.infimum([s,s2,s3])
e #e stands for the empty schema
Schematic completion and drawing the schematic lattice:
.. code-block:: python
>>> import schematax
>>> xs = ['111', '011', '001']
>>> ss = schematax.complete(xs) #performing schematic completion
>>> ss
[111, 011, 001,``*11``, ``**1``, ``0*1``, e] #e stands for the empty schema
>>> schematax.draw(ss,'my_lattice') #draws the schematic lattice of ss and saves it as my_lattice.pdf
The image produced here:
.. image:: https://github.com/iSTB/python-schemata/blob/master/docs/my_lattice.png?raw=true
:align: center
Further reading
---------------
- https://en.wikipedia.org/wiki/Schema_%28genetic_algorithms%29
- https://en.wikipedia.org/wiki/Lattice_%28order%29
See also
--------
The implementation is based on these Python packages:
- graphviz_ |--| Simple Python interface for Graphviz
License
-------
Schemata is distributed under the `MIT license`_.
.. _Complete Lattice: https://en.wikipedia.org/wiki/Complete_lattice
.. _schemata: https://en.wikipedia.org/wiki/Schema_%28genetic_algorithms%29
.. _pip: http://pip.readthedocs.org
.. _Graphviz software: http://www.graphviz.org
.. _graphviz: http://pypi.python.org/pypi/graphviz
.. _MIT license: http://opensource.org/licenses/MIT
.. |--| unicode:: U+2013
.. |PyPI version| image:: https://img.shields.io/pypi/v/schematax.svg
:target: https://pypi.python.org/pypi/schematax
:alt: Latest PyPI Version
.. |License| image:: https://img.shields.io/pypi/l/schematax.svg
:target: https://pypi.python.org/pypi/concepts
:alt: License
.. |Supported Python| image:: https://img.shields.io/pypi/pyversions/schematax.svg
:target: https://pypi.python.org/pypi/schematax
:alt: Supported Python Versions
.. |Format| image:: https://img.shields.io/pypi/format/schematax.svg
:target: https://pypi.python.org/pypi/concepts
:alt: Format
.. |Downloads| image:: https://img.shields.io/pypi/dm/schematax.svg
:target: https://pypi.python.org/pypi/schematax
:alt: Downloads
|
schematax
|
/schematax-0.1.6.tar.gz/schematax-0.1.6/README.rst
|
README.rst
|
schematax
=========
|PyPI version| |License| |Supported Python| |Format| |Downloads|
schematax is a simple Python package to do all things related to schemata_.
A schema is word made using an extra symbol, '*', called the wild card symbol.
For example the schema over the binary aplhapbet '1*0', represents the set of
strings. {'100','110'}'.
Schema have properties. For example, for a schema s, the order of s is the
number of symbols in s which are not the wild card symbols (called fixed symbols).
The defining length of s is the distance between the first and last fixed symbol.
Given a set of words of the same length S, the schematic completion of S
returns all schema which make subsets of the words in S.
Whats more given the partial ordering over schemata, the schematic completion of S
forms a `Complete Lattice`_.
Links
-----
- GitHub:https://github.com/iSTB/python-schemata
- PyPI: http://pypi.python.org/pypi/schematax
- Issue Tracker: https://github.com/iSTB/python-schemata/issues
- Download: http://pypi.python.org/pypi/schematax#downloads
Installation
------------
This package runs under Python 2.7, use pip_ to install:
.. code:: bash
$ pip install schematax
This will also install the graphviz_ package from PyPI as
required dependencies.
**Important**: Drawing the the schematic lattice uses `Graphviz software`_. Make sure it
is installed and ``dot`` executable is on your systems' path.
Quickstart
----------
The file example.py gives a good overview of how to use the package.
Basic schema operations:
.. code-block:: python
>>> import schematax
>>> s = schematax.schema('10*1') #makes a schema
>>> s
10*1
>>> s.get_order()
3
>>> s.get_defining_length()
3
>>> s2 = schematax.schema('1**1') #makes another schema
>>> s <= s2
True
>>> s < s2
True
>>> s == s2
False
>>> schematax.meet(s,s2)
10*1
>>> schematax.join(s,s2)
1**1
>>> s3 = schematax.schema('00*1')
>>> schematax.supremum([s,s2,s3])
***1
>>> schematax.infimum([s,s2,s3])
e #e stands for the empty schema
Schematic completion and drawing the schematic lattice:
.. code-block:: python
>>> import schematax
>>> xs = ['111', '011', '001']
>>> ss = schematax.complete(xs) #performing schematic completion
>>> ss
[111, 011, 001,``*11``, ``**1``, ``0*1``, e] #e stands for the empty schema
>>> schematax.draw(ss,'my_lattice') #draws the schematic lattice of ss and saves it as my_lattice.pdf
The image produced here:
.. image:: https://github.com/iSTB/python-schemata/blob/master/docs/my_lattice.png?raw=true
:align: center
Further reading
---------------
- https://en.wikipedia.org/wiki/Schema_%28genetic_algorithms%29
- https://en.wikipedia.org/wiki/Lattice_%28order%29
See also
--------
The implementation is based on these Python packages:
- graphviz_ |--| Simple Python interface for Graphviz
License
-------
Schemata is distributed under the `MIT license`_.
.. _Complete Lattice: https://en.wikipedia.org/wiki/Complete_lattice
.. _schemata: https://en.wikipedia.org/wiki/Schema_%28genetic_algorithms%29
.. _pip: http://pip.readthedocs.org
.. _Graphviz software: http://www.graphviz.org
.. _graphviz: http://pypi.python.org/pypi/graphviz
.. _MIT license: http://opensource.org/licenses/MIT
.. |--| unicode:: U+2013
.. |PyPI version| image:: https://img.shields.io/pypi/v/schematax.svg
:target: https://pypi.python.org/pypi/schematax
:alt: Latest PyPI Version
.. |License| image:: https://img.shields.io/pypi/l/schematax.svg
:target: https://pypi.python.org/pypi/concepts
:alt: License
.. |Supported Python| image:: https://img.shields.io/pypi/pyversions/schematax.svg
:target: https://pypi.python.org/pypi/schematax
:alt: Supported Python Versions
.. |Format| image:: https://img.shields.io/pypi/format/schematax.svg
:target: https://pypi.python.org/pypi/concepts
:alt: Format
.. |Downloads| image:: https://img.shields.io/pypi/dm/schematax.svg
:target: https://pypi.python.org/pypi/schematax
:alt: Downloads
| 0.911887 | 0.79049 |
Schematec
=========
.. image:: https://travis-ci.org/mylokin/redisext.svg?branch=master
:target: https://travis-ci.org/mylokin/redisext
Schematec is a set of tools that makes input data validation easier.
The purpose of this code is attempt to bring simplicity to applications
logics using separation of data validation and actual data processing.
Quickstart
----------
.. code:: python
import schematec as s
schema = s.dictionary(
id=s.integer & s.required,
name=s.string,
tags=s.array(s.string),
)
.. code:: python
>>> data = {
... 'id': '1',
... 'name': 'Red Hot Chili Peppers',
... 'tags': ['funk', 'rock'],
... 'rank': '1',
... }
>>> schema(data)
{'id': 1, 'name': u'Red Hot Chili Peppers', 'tags': [u'funk', u'rock']}
Concepts
--------
Schematec module is based on three basic concepts:
* Schema
* Validator
* Converter
Schema
^^^^^^
Term "schema" is used to describe complex data struct such as dictionary(hashmap)
or array(list). Schemas has two different types of validation (it is not related to
array schemas):
* Default - Only values with required validator are required, other values are optional
* Weak - All values are optional
`schematec.exc.SchemaError` is raised in case provided data is incorrect.
Order of schema validations:
#. Unbound Validators
#. Schemas(inner)
#. Converters
#. Bound Validators
Validator
^^^^^^^^^
Term "validator" describes callable objects that perform different types of checks.
There are two types of validators in schematec:
* Bound - type related, for example "max length" validator is bound to sized type.
* Unbound - universal, for example "required" validator.
Raises `schematec.exc.ValidationError`.
Schematec provides following validators:
required
check if value is provided
length
check iterable for max length
regex
check if given value is valid
Converter
^^^^^^^^^
Term "converter" is used to describe cast functions. Schematec supports subset of JSON
data types.
Basic types:
- integer(int)
- string(str)
- boolean(bool)
Containers:
- array(list)
- dictionary(dict)
Raises `schematec.exc.ConvertationError`.
Convertation rules
=================
integer
-------
#. Any int or long value
#. Any suitable string/unicode
#. Boolean value
number
-------
#. Any float or int or long value
#. Any suitable string/unicode
#. Boolean value
string
------
#. Any suitable string/unicode
#. Any int or long value
boolean
-------
#. Boolean value
#. 0 or 1
#. '0' or '1'
#. u'0' or u'1'
dictionary
----------
#. Any mapping value(collections.Mapping)
array
-----
#. Any iterable value(collections.Iterable), but not a mapping
Complex Descriptors
===================
"Schema", "validator" and "converter" are internally referenced as "descriptors". Common task is
creation of complex validation rules for a field(or "complex descriptors"). To do this use bitwise
"and" operator on descriptors:
.. code:: python
>>> import schematec
>>> schematec.integer & schematec.required
<schematec.abc.ComplexDescriptor object at 0x10b05a0d0>
Sugar Schema
============
Schematec supports additional "magic" way to define your schemas. You can use simple dicts and lists
to describe your data. For example:
.. code:: python
>>> import schematec as s
>>> schema = {
... 'a': [{
... 'b': s.integer,
... }]
... }
>>> data = {
... 'a': [{'b': 1}, {'b': '1'}, {}]
... }
>>> s.process(schema, data)
{'a': [{'b': 1}, {'b': 1}, {}]}
Examples
========
Recursive schema
----------------
.. code:: python
import schematec as s
schema = s.dictionary(
id=s.integer & s.required,
entity=s.dictionary(
name=s.string & s.required,
value=s.string,
)
)
.. code:: python
>>> data = {
... 'id': 1,
... 'entity': {
... 'name': 'song',
... 'value': 'californication',
... }
... }
>>> schema(data)
{'id': 1, 'entity': {'name': u'song', 'value': u'californication'}}
Errors handling
---------------
.. code:: python
import schematec as s
schema = s.dictionary(
id=s.integer & s.required,
entity=s.dictionary(
name=s.string & s.required,
value=s.string,
)
)
.. code:: python
>>> data = {
... 'id': 1,
... 'entity': {
... 'value': 'californication',
... }
... }
>>> schema(data)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "schematec/schema.py", line 44, in __call__
value = schema(value, weak=weak)
File "schematec/schema.py", line 32, in __call__
validator(name, data)
File "schematec/validators.py", line 12, in __call__
raise exc.ValidationError(name)
schematec.exc.ValidationError: name
|
schematec
|
/schematec-0.5.2.tar.gz/schematec-0.5.2/README.rst
|
README.rst
|
Schematec
=========
.. image:: https://travis-ci.org/mylokin/redisext.svg?branch=master
:target: https://travis-ci.org/mylokin/redisext
Schematec is a set of tools that makes input data validation easier.
The purpose of this code is attempt to bring simplicity to applications
logics using separation of data validation and actual data processing.
Quickstart
----------
.. code:: python
import schematec as s
schema = s.dictionary(
id=s.integer & s.required,
name=s.string,
tags=s.array(s.string),
)
.. code:: python
>>> data = {
... 'id': '1',
... 'name': 'Red Hot Chili Peppers',
... 'tags': ['funk', 'rock'],
... 'rank': '1',
... }
>>> schema(data)
{'id': 1, 'name': u'Red Hot Chili Peppers', 'tags': [u'funk', u'rock']}
Concepts
--------
Schematec module is based on three basic concepts:
* Schema
* Validator
* Converter
Schema
^^^^^^
Term "schema" is used to describe complex data struct such as dictionary(hashmap)
or array(list). Schemas has two different types of validation (it is not related to
array schemas):
* Default - Only values with required validator are required, other values are optional
* Weak - All values are optional
`schematec.exc.SchemaError` is raised in case provided data is incorrect.
Order of schema validations:
#. Unbound Validators
#. Schemas(inner)
#. Converters
#. Bound Validators
Validator
^^^^^^^^^
Term "validator" describes callable objects that perform different types of checks.
There are two types of validators in schematec:
* Bound - type related, for example "max length" validator is bound to sized type.
* Unbound - universal, for example "required" validator.
Raises `schematec.exc.ValidationError`.
Schematec provides following validators:
required
check if value is provided
length
check iterable for max length
regex
check if given value is valid
Converter
^^^^^^^^^
Term "converter" is used to describe cast functions. Schematec supports subset of JSON
data types.
Basic types:
- integer(int)
- string(str)
- boolean(bool)
Containers:
- array(list)
- dictionary(dict)
Raises `schematec.exc.ConvertationError`.
Convertation rules
=================
integer
-------
#. Any int or long value
#. Any suitable string/unicode
#. Boolean value
number
-------
#. Any float or int or long value
#. Any suitable string/unicode
#. Boolean value
string
------
#. Any suitable string/unicode
#. Any int or long value
boolean
-------
#. Boolean value
#. 0 or 1
#. '0' or '1'
#. u'0' or u'1'
dictionary
----------
#. Any mapping value(collections.Mapping)
array
-----
#. Any iterable value(collections.Iterable), but not a mapping
Complex Descriptors
===================
"Schema", "validator" and "converter" are internally referenced as "descriptors". Common task is
creation of complex validation rules for a field(or "complex descriptors"). To do this use bitwise
"and" operator on descriptors:
.. code:: python
>>> import schematec
>>> schematec.integer & schematec.required
<schematec.abc.ComplexDescriptor object at 0x10b05a0d0>
Sugar Schema
============
Schematec supports additional "magic" way to define your schemas. You can use simple dicts and lists
to describe your data. For example:
.. code:: python
>>> import schematec as s
>>> schema = {
... 'a': [{
... 'b': s.integer,
... }]
... }
>>> data = {
... 'a': [{'b': 1}, {'b': '1'}, {}]
... }
>>> s.process(schema, data)
{'a': [{'b': 1}, {'b': 1}, {}]}
Examples
========
Recursive schema
----------------
.. code:: python
import schematec as s
schema = s.dictionary(
id=s.integer & s.required,
entity=s.dictionary(
name=s.string & s.required,
value=s.string,
)
)
.. code:: python
>>> data = {
... 'id': 1,
... 'entity': {
... 'name': 'song',
... 'value': 'californication',
... }
... }
>>> schema(data)
{'id': 1, 'entity': {'name': u'song', 'value': u'californication'}}
Errors handling
---------------
.. code:: python
import schematec as s
schema = s.dictionary(
id=s.integer & s.required,
entity=s.dictionary(
name=s.string & s.required,
value=s.string,
)
)
.. code:: python
>>> data = {
... 'id': 1,
... 'entity': {
... 'value': 'californication',
... }
... }
>>> schema(data)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "schematec/schema.py", line 44, in __call__
value = schema(value, weak=weak)
File "schematec/schema.py", line 32, in __call__
validator(name, data)
File "schematec/validators.py", line 12, in __call__
raise exc.ValidationError(name)
schematec.exc.ValidationError: name
| 0.920816 | 0.502014 |
Contributing to Schemathesis
============================
Welcome! We are delighted that you're reading this!
Your feedback and your experience are essential for the project :)
.. contents::
:depth: 2
:backlinks: none
Feature requests and feedback
-----------------------------
If you'd like to suggest a feature, feel free to `submit an issue <https://github.com/schemathesis/schemathesis/issues>`_
and:
* Write a simple and descriptive title to identify your suggestion.
* Provide as many details as possible, explain your context, and how the feature should work.
* Explain why this improvement would be useful.
* Keep the scope narrow. It will make it easier to implement.
Report bugs
-----------
Report bugs for Schemathesis in the `issue tracker <https://github.com/schemathesis/schemathesis/issues>`_.
If you are reporting a bug, please:
* Write a simple and descriptive title to identify the problem.
* Describe the exact steps which reproduce the problem in as many details as possible.
* Describe the behavior you observed after following the steps and point out the problem with that behavior.
* Explain which behavior you expected to see instead and why.
* Include Python / Schemathesis versions.
It would be awesome if you can submit a failing test that demonstrates the problem.
Submitting Pull Requests
------------------------
#. Fork the repository.
#. Enable and install `pre-commit <https://pre-commit.com>`_ to ensure style-guides and code checks are followed.
#. Target the ``master`` branch.
#. Follow **PEP-8** for naming and `black <https://github.com/psf/black>`_ for formatting.
#. Tests are run using ``tox``::
tox -e py37
The test environment above is usually enough to cover most cases locally.
#. Write an entry to `changelog.rst <https://github.com/schemathesis/schemathesis/blob/master/docs/changelog.rst>`_
#. Format your commit message according to the Conventional Commits `specification <https://www.conventionalcommits.org/en/>`_
For each pull request, we aim to review it as soon as possible.
If you wait a few days without a reply, please feel free to ping the thread by adding a new comment.
Using a local test server
-------------------------
Schemathesis provides a local test server to simplify the development of new features or fixing bugs.
It allows you to configure the generated API schema to reflect various common scenarios of server-side behavior.
To start using it, you need to prepare a virtual environment.
.. code:: bash
pip install
To start the server, run the following command in your terminal:
.. code:: bash
./test_server.sh 8081
It will start the test server on the 8081 port with a simple Open API 2.0 schema.
The local server supports three specs via the ``--spec`` command-line option - ``openapi2``, ``openapi3``, and ``graphql``.
GraphQL
~~~~~~~
This spec serves a simple schema:
.. code:: graphql
type Author {
name: String
books: [Book]
}
type Book {
title: String
author: Author
}
type Query {
getBooks: [Book]
getAuthors: [Author]
}
OpenAPI
~~~~~~~
Both ``openapi2`` and ``openapi3`` expose semantically the same schema with version-specific keywords.
By default, the server will generate an API schema with the following API operations:
- ``GET /api/success`` - returns ``{"success": true}``
- ``GET /api/failure`` - returns 500 with the ``text/plain`` content type
- ``POST /api/payload`` - returns the request's payload
- ``GET /api/get_payload`` - returns the request's payload, but accepts only GET requests
- ``GET /api/multiple_failures`` - returns different response statuses, depending on the provided integer ``id`` parameter. For negative values returns 200 with ``{"result": "OK"}`` payload, 500 if ``id`` is 0, and 504 for positive ``id`` values.
- ``GET /api/slow`` - always returns ``{"slow": true}`` after 100 ms delay
- ``GET /api/path_variable/{key}`` - receives the ``key`` path parameter and unconditionally returns ``{"success": true}``
- ``POST /api/unsatisfiable`` - parameters for this operation are impossible to generate
- ``POST /api/performance`` - depending on the number of "0" in the input value, responds slower and if the input value has more than ten "0", returns 500
- ``GET /api/flaky`` - returns 1:1 ratio of 200/500 responses
- ``GET /api/recursive`` - accepts a recursive structure and responds with a recursive one
- ``GET /api/basic`` - Requires HTTP basic auth (use `test` as username and password)
- ``GET /api/empty`` - Returns an empty response
- ``GET /api/empty_string`` - Returns a response with an empty string as a payload
- ``POST /api/multipart`` - accepts two body parameters as multipart payload
- ``POST /api/upload_file`` - accepts a file and a body parameter
- ``POST /api/form`` - accepts ``application/x-www-form-urlencoded`` payload
- ``POST /api/teapot`` - returns 418 status code that is not listed in the schema
- ``GET /api/text`` - returns ``text/plain`` responses, which are not declared in the schema
- ``GET /api/cp866`` - returns ``text/plain`` responses encoded with CP866. This content type is not expected by the schema
- ``POST /api/text`` - expects payload as ``text/plain``
- ``POST /api/csv`` - expects payload as ``text/csv`` and returns its equivalent in JSON.
- ``GET /api/malformed_json`` - returns malformed JSON with ``application/json`` content type header
- ``GET /api/custom_format`` - accepts a string in the custom "digits" format. This operation is used to verify custom string formats
- ``GET /api/headers`` - returns the passed headers
- ``POST /api/users/`` (``create_user``) - creates a user and stores it in memory. Provides Open API links to the operations below
- ``GET /api/users/{user_id}`` (``get_user``) - returns a user stored in memory
- ``PATCH /api/users/{user_id}`` (``update_user``) - updates a user stored in memory
- ``GET /api/foo:bar`` (``reserved``) - contains ``:`` in its path
- ``GET /api/read_only`` - includes `readOnly` properties in its schema
- ``POST /api/write_only`` - includes `writeOnly` properties in its schema
You can find the complete schema at ``http://127.0.0.1:8081/schema.yaml`` (replace 8081 with the port you chose in the start server command).
There are also few operations with deliberately malformed schemas, that are not included by default:
- ``POST /api/invalid`` - invalid parameter definition. Uses ``int`` instead of ``integer``
- ``GET /api/invalid_response`` - response doesn't conform to the declared schema
- ``GET /api/invalid_path_parameter/{id}`` - the parameter declaration is invalid (``required`` keyword is set to ``false``)
- ``GET /api/missing_path_parameter/{id}`` - the ``id`` parameter is missing
To select only a subset of the operations above, you could use the ``--operations`` command-line option and provide a
list of names separated by a comma. Values in this list are either mentioned in parentheses or are the path part after ``/api/``.
For example, to select the ``GET /api/success``, ``GET /api/path_variable/{key}``, and ``POST /api/users/`` operations, you can run the following command:
.. code:: bash
./test_server.sh 8081 --operations=success,path_variable,create_user
To select all available operations, use ``--operations=all``.
Then you could use CLI against this server:
.. code::
st run http://127.0.0.1:8081/schema.yaml
=========================================== Schemathesis test session starts ==========================================
platform Linux -- Python 3.8.5, schemathesis-2.5.0, hypothesis-5.23.0, hypothesis_jsonschema-0.17.3, jsonschema-3.2.0
rootdir: /
hypothesis profile 'default' -> database=DirectoryBasedExampleDatabase('/.hypothesis/examples')
Schema location: http://127.0.0.1:8081/schema.yaml
Base URL: http://127.0.0.1:8081/api
Specification version: Swagger 2.0
Workers: 1
Collected API operations: 3
GET /api/path_variable/{key} . [ 33%]
GET /api/success . [ 66%]
POST /api/users/ . [100%]
======================================================= SUMMARY =======================================================
Performed checks:
not_a_server_error 201 / 201 passed PASSED
================================================== 3 passed in 1.77s ==================================================
Maintainers
-----------
At present, the core developers are:
- Dmitry Dygalo (`@Stranger6667`_)
Preferred communication language
--------------------------------
We prefer to keep all communications in English.
Thanks!
.. _@Stranger6667: https://github.com/Stranger6667
|
schemathesis
|
/schemathesis-3.19.2.tar.gz/schemathesis-3.19.2/CONTRIBUTING.rst
|
CONTRIBUTING.rst
|
Contributing to Schemathesis
============================
Welcome! We are delighted that you're reading this!
Your feedback and your experience are essential for the project :)
.. contents::
:depth: 2
:backlinks: none
Feature requests and feedback
-----------------------------
If you'd like to suggest a feature, feel free to `submit an issue <https://github.com/schemathesis/schemathesis/issues>`_
and:
* Write a simple and descriptive title to identify your suggestion.
* Provide as many details as possible, explain your context, and how the feature should work.
* Explain why this improvement would be useful.
* Keep the scope narrow. It will make it easier to implement.
Report bugs
-----------
Report bugs for Schemathesis in the `issue tracker <https://github.com/schemathesis/schemathesis/issues>`_.
If you are reporting a bug, please:
* Write a simple and descriptive title to identify the problem.
* Describe the exact steps which reproduce the problem in as many details as possible.
* Describe the behavior you observed after following the steps and point out the problem with that behavior.
* Explain which behavior you expected to see instead and why.
* Include Python / Schemathesis versions.
It would be awesome if you can submit a failing test that demonstrates the problem.
Submitting Pull Requests
------------------------
#. Fork the repository.
#. Enable and install `pre-commit <https://pre-commit.com>`_ to ensure style-guides and code checks are followed.
#. Target the ``master`` branch.
#. Follow **PEP-8** for naming and `black <https://github.com/psf/black>`_ for formatting.
#. Tests are run using ``tox``::
tox -e py37
The test environment above is usually enough to cover most cases locally.
#. Write an entry to `changelog.rst <https://github.com/schemathesis/schemathesis/blob/master/docs/changelog.rst>`_
#. Format your commit message according to the Conventional Commits `specification <https://www.conventionalcommits.org/en/>`_
For each pull request, we aim to review it as soon as possible.
If you wait a few days without a reply, please feel free to ping the thread by adding a new comment.
Using a local test server
-------------------------
Schemathesis provides a local test server to simplify the development of new features or fixing bugs.
It allows you to configure the generated API schema to reflect various common scenarios of server-side behavior.
To start using it, you need to prepare a virtual environment.
.. code:: bash
pip install
To start the server, run the following command in your terminal:
.. code:: bash
./test_server.sh 8081
It will start the test server on the 8081 port with a simple Open API 2.0 schema.
The local server supports three specs via the ``--spec`` command-line option - ``openapi2``, ``openapi3``, and ``graphql``.
GraphQL
~~~~~~~
This spec serves a simple schema:
.. code:: graphql
type Author {
name: String
books: [Book]
}
type Book {
title: String
author: Author
}
type Query {
getBooks: [Book]
getAuthors: [Author]
}
OpenAPI
~~~~~~~
Both ``openapi2`` and ``openapi3`` expose semantically the same schema with version-specific keywords.
By default, the server will generate an API schema with the following API operations:
- ``GET /api/success`` - returns ``{"success": true}``
- ``GET /api/failure`` - returns 500 with the ``text/plain`` content type
- ``POST /api/payload`` - returns the request's payload
- ``GET /api/get_payload`` - returns the request's payload, but accepts only GET requests
- ``GET /api/multiple_failures`` - returns different response statuses, depending on the provided integer ``id`` parameter. For negative values returns 200 with ``{"result": "OK"}`` payload, 500 if ``id`` is 0, and 504 for positive ``id`` values.
- ``GET /api/slow`` - always returns ``{"slow": true}`` after 100 ms delay
- ``GET /api/path_variable/{key}`` - receives the ``key`` path parameter and unconditionally returns ``{"success": true}``
- ``POST /api/unsatisfiable`` - parameters for this operation are impossible to generate
- ``POST /api/performance`` - depending on the number of "0" in the input value, responds slower and if the input value has more than ten "0", returns 500
- ``GET /api/flaky`` - returns 1:1 ratio of 200/500 responses
- ``GET /api/recursive`` - accepts a recursive structure and responds with a recursive one
- ``GET /api/basic`` - Requires HTTP basic auth (use `test` as username and password)
- ``GET /api/empty`` - Returns an empty response
- ``GET /api/empty_string`` - Returns a response with an empty string as a payload
- ``POST /api/multipart`` - accepts two body parameters as multipart payload
- ``POST /api/upload_file`` - accepts a file and a body parameter
- ``POST /api/form`` - accepts ``application/x-www-form-urlencoded`` payload
- ``POST /api/teapot`` - returns 418 status code that is not listed in the schema
- ``GET /api/text`` - returns ``text/plain`` responses, which are not declared in the schema
- ``GET /api/cp866`` - returns ``text/plain`` responses encoded with CP866. This content type is not expected by the schema
- ``POST /api/text`` - expects payload as ``text/plain``
- ``POST /api/csv`` - expects payload as ``text/csv`` and returns its equivalent in JSON.
- ``GET /api/malformed_json`` - returns malformed JSON with ``application/json`` content type header
- ``GET /api/custom_format`` - accepts a string in the custom "digits" format. This operation is used to verify custom string formats
- ``GET /api/headers`` - returns the passed headers
- ``POST /api/users/`` (``create_user``) - creates a user and stores it in memory. Provides Open API links to the operations below
- ``GET /api/users/{user_id}`` (``get_user``) - returns a user stored in memory
- ``PATCH /api/users/{user_id}`` (``update_user``) - updates a user stored in memory
- ``GET /api/foo:bar`` (``reserved``) - contains ``:`` in its path
- ``GET /api/read_only`` - includes `readOnly` properties in its schema
- ``POST /api/write_only`` - includes `writeOnly` properties in its schema
You can find the complete schema at ``http://127.0.0.1:8081/schema.yaml`` (replace 8081 with the port you chose in the start server command).
There are also few operations with deliberately malformed schemas, that are not included by default:
- ``POST /api/invalid`` - invalid parameter definition. Uses ``int`` instead of ``integer``
- ``GET /api/invalid_response`` - response doesn't conform to the declared schema
- ``GET /api/invalid_path_parameter/{id}`` - the parameter declaration is invalid (``required`` keyword is set to ``false``)
- ``GET /api/missing_path_parameter/{id}`` - the ``id`` parameter is missing
To select only a subset of the operations above, you could use the ``--operations`` command-line option and provide a
list of names separated by a comma. Values in this list are either mentioned in parentheses or are the path part after ``/api/``.
For example, to select the ``GET /api/success``, ``GET /api/path_variable/{key}``, and ``POST /api/users/`` operations, you can run the following command:
.. code:: bash
./test_server.sh 8081 --operations=success,path_variable,create_user
To select all available operations, use ``--operations=all``.
Then you could use CLI against this server:
.. code::
st run http://127.0.0.1:8081/schema.yaml
=========================================== Schemathesis test session starts ==========================================
platform Linux -- Python 3.8.5, schemathesis-2.5.0, hypothesis-5.23.0, hypothesis_jsonschema-0.17.3, jsonschema-3.2.0
rootdir: /
hypothesis profile 'default' -> database=DirectoryBasedExampleDatabase('/.hypothesis/examples')
Schema location: http://127.0.0.1:8081/schema.yaml
Base URL: http://127.0.0.1:8081/api
Specification version: Swagger 2.0
Workers: 1
Collected API operations: 3
GET /api/path_variable/{key} . [ 33%]
GET /api/success . [ 66%]
POST /api/users/ . [100%]
======================================================= SUMMARY =======================================================
Performed checks:
not_a_server_error 201 / 201 passed PASSED
================================================== 3 passed in 1.77s ==================================================
Maintainers
-----------
At present, the core developers are:
- Dmitry Dygalo (`@Stranger6667`_)
Preferred communication language
--------------------------------
We prefer to keep all communications in English.
Thanks!
.. _@Stranger6667: https://github.com/Stranger6667
| 0.848565 | 0.635866 |
import argparse
import datetime
import re
import sys
from typing import Generator, List, Optional
PYPROJECT_PATH = "pyproject.toml"
CHANGELOG_PATH = "docs/changelog.rst"
COMPARE_URL_PREFIX = "https://github.com/schemathesis/schemathesis/compare/"
def _read_changelog() -> List[str]:
with open(CHANGELOG_PATH) as f:
return f.readlines()
def _find_line_by_prefix(lines: List[str], prefix: str) -> Optional[int]:
return next((i for i, line in enumerate(lines) if line.startswith(prefix)), None)
def bump(new_version: str) -> None:
today = datetime.datetime.now().strftime("%Y-%m-%d")
# Read changelog into lines
changelog = _read_changelog()
# Find the position of the "Unreleased" block
unreleased_idx = _find_line_by_prefix(changelog, "`Unreleased`_ -")
if unreleased_idx is None:
raise RuntimeError("Changelog has no `Unreleased` section")
# Place to insert the new release block
new_version_idx = unreleased_idx + 3
if changelog[new_version_idx].startswith(".. _v"):
raise RuntimeError("New version has no changes")
# Insert the new release block before the "Unreleased" block
new_version_link = f".. _v{new_version}:\n\n"
new_version_line = f"`{new_version}`_ - {today}"
new_version_underline = f"\n{'-' * len(new_version_line)}\n\n"
changelog.insert(new_version_idx, f"{new_version_link}{new_version_line}{new_version_underline}")
# Find the position of the link for the "Unreleased" diff & rewrite it with the new version
unreleased_diff_idx = _find_line_by_prefix(changelog, f".. _Unreleased: {COMPARE_URL_PREFIX}")
if unreleased_diff_idx is None:
raise RuntimeError("Changelog has no diff for the `Unreleased` section")
changelog[unreleased_diff_idx] = f".. _Unreleased: {COMPARE_URL_PREFIX}v{new_version}...HEAD\n"
# Extract the old version from the next line
# `.. _3.18.2: ...` => `3.18.2`
old_version_diff_idx = unreleased_diff_idx + 1
old_version = changelog[old_version_diff_idx].split(":")[0][4:]
# Insert the diff for the new version
new_version_diff = f".. _{new_version}: {COMPARE_URL_PREFIX}v{old_version}...v{new_version}\n"
changelog.insert(old_version_diff_idx, new_version_diff)
# Write the updated changelog back to the file
with open(CHANGELOG_PATH, "w") as f:
f.writelines(changelog)
# Update `pyproject.toml`
with open(PYPROJECT_PATH) as f:
pyproject = f.readlines()
version_idx = _find_line_by_prefix(pyproject, f'version = "{old_version}"')
if version_idx is None:
raise RuntimeError("`pyproject.toml` has no `version` field")
pyproject[version_idx] = f'version = "{new_version}"\n'
with open(PYPROJECT_PATH, "w") as f:
f.writelines(pyproject)
def to_markdown(version: str) -> None:
changelog = _read_changelog()
# Find the start and end lines for the provided version
start_idx = _find_line_by_prefix(changelog, f".. _v{version}")
if start_idx is None:
raise RuntimeError(f"Changelog misses the {version} version")
start_idx += 4 # Skip the version link + version line and its underline
end_idx = _find_line_by_prefix(changelog[start_idx + 1 :], ".. _v")
if end_idx is None:
raise RuntimeError("Changelog is missing the previous version")
md_lines = _rst_to_md(changelog[start_idx : end_idx + start_idx])
sys.stdout.write("\n".join(md_lines))
sys.stdout.write("\n")
def _format_section(section: str) -> str:
emoji = {
"Added": "rocket",
"Changed": "wrench",
"Deprecated": "wastebasket",
"Fixed": "bug",
"Performance": "racing_car",
"Removed": "fire",
}.get(section, "wrench")
return f"\n### :{emoji}: {section}\n"
# Matches strings that look like "`#123`_"
GITHUB_LINK_RE = re.compile(r"`#([0-9]+)`_")
def clean_line(text: str) -> str:
return GITHUB_LINK_RE.sub(lambda m: m.group().strip("`_"), text).replace("``", "`")
def _rst_to_md(lines: List[str]) -> Generator[str, None, None]:
for line in lines:
line = line.strip()
if line.startswith("**"):
section = line.strip("*")
yield _format_section(section)
elif line:
yield clean_line(line)
def build_parser() -> argparse.ArgumentParser:
argument_parser = argparse.ArgumentParser(description="Manage Schemathesis changelog.")
subparsers = argument_parser.add_subparsers(title="subcommands", dest="subcommand")
# `bump` subcommand
bump_parser = subparsers.add_parser("bump", help="Bump the version of the changelog")
bump_parser.add_argument("new_version", type=str, help="The new version number to bump to")
# `md` subcommand
md_parser = subparsers.add_parser("md", help="Transform the changelog for a specific version into markdown style")
md_parser.add_argument("version", type=str, help="The version to transform into markdown")
return argument_parser
if __name__ == "__main__":
parser = build_parser()
args = parser.parse_args()
if args.subcommand == "bump":
bump(args.new_version)
elif args.subcommand == "md":
to_markdown(args.version)
else:
parser.error("Missing subcommand")
|
schemathesis
|
/schemathesis-3.19.2.tar.gz/schemathesis-3.19.2/changelog.py
|
changelog.py
|
import argparse
import datetime
import re
import sys
from typing import Generator, List, Optional
PYPROJECT_PATH = "pyproject.toml"
CHANGELOG_PATH = "docs/changelog.rst"
COMPARE_URL_PREFIX = "https://github.com/schemathesis/schemathesis/compare/"
def _read_changelog() -> List[str]:
with open(CHANGELOG_PATH) as f:
return f.readlines()
def _find_line_by_prefix(lines: List[str], prefix: str) -> Optional[int]:
return next((i for i, line in enumerate(lines) if line.startswith(prefix)), None)
def bump(new_version: str) -> None:
today = datetime.datetime.now().strftime("%Y-%m-%d")
# Read changelog into lines
changelog = _read_changelog()
# Find the position of the "Unreleased" block
unreleased_idx = _find_line_by_prefix(changelog, "`Unreleased`_ -")
if unreleased_idx is None:
raise RuntimeError("Changelog has no `Unreleased` section")
# Place to insert the new release block
new_version_idx = unreleased_idx + 3
if changelog[new_version_idx].startswith(".. _v"):
raise RuntimeError("New version has no changes")
# Insert the new release block before the "Unreleased" block
new_version_link = f".. _v{new_version}:\n\n"
new_version_line = f"`{new_version}`_ - {today}"
new_version_underline = f"\n{'-' * len(new_version_line)}\n\n"
changelog.insert(new_version_idx, f"{new_version_link}{new_version_line}{new_version_underline}")
# Find the position of the link for the "Unreleased" diff & rewrite it with the new version
unreleased_diff_idx = _find_line_by_prefix(changelog, f".. _Unreleased: {COMPARE_URL_PREFIX}")
if unreleased_diff_idx is None:
raise RuntimeError("Changelog has no diff for the `Unreleased` section")
changelog[unreleased_diff_idx] = f".. _Unreleased: {COMPARE_URL_PREFIX}v{new_version}...HEAD\n"
# Extract the old version from the next line
# `.. _3.18.2: ...` => `3.18.2`
old_version_diff_idx = unreleased_diff_idx + 1
old_version = changelog[old_version_diff_idx].split(":")[0][4:]
# Insert the diff for the new version
new_version_diff = f".. _{new_version}: {COMPARE_URL_PREFIX}v{old_version}...v{new_version}\n"
changelog.insert(old_version_diff_idx, new_version_diff)
# Write the updated changelog back to the file
with open(CHANGELOG_PATH, "w") as f:
f.writelines(changelog)
# Update `pyproject.toml`
with open(PYPROJECT_PATH) as f:
pyproject = f.readlines()
version_idx = _find_line_by_prefix(pyproject, f'version = "{old_version}"')
if version_idx is None:
raise RuntimeError("`pyproject.toml` has no `version` field")
pyproject[version_idx] = f'version = "{new_version}"\n'
with open(PYPROJECT_PATH, "w") as f:
f.writelines(pyproject)
def to_markdown(version: str) -> None:
changelog = _read_changelog()
# Find the start and end lines for the provided version
start_idx = _find_line_by_prefix(changelog, f".. _v{version}")
if start_idx is None:
raise RuntimeError(f"Changelog misses the {version} version")
start_idx += 4 # Skip the version link + version line and its underline
end_idx = _find_line_by_prefix(changelog[start_idx + 1 :], ".. _v")
if end_idx is None:
raise RuntimeError("Changelog is missing the previous version")
md_lines = _rst_to_md(changelog[start_idx : end_idx + start_idx])
sys.stdout.write("\n".join(md_lines))
sys.stdout.write("\n")
def _format_section(section: str) -> str:
emoji = {
"Added": "rocket",
"Changed": "wrench",
"Deprecated": "wastebasket",
"Fixed": "bug",
"Performance": "racing_car",
"Removed": "fire",
}.get(section, "wrench")
return f"\n### :{emoji}: {section}\n"
# Matches strings that look like "`#123`_"
GITHUB_LINK_RE = re.compile(r"`#([0-9]+)`_")
def clean_line(text: str) -> str:
return GITHUB_LINK_RE.sub(lambda m: m.group().strip("`_"), text).replace("``", "`")
def _rst_to_md(lines: List[str]) -> Generator[str, None, None]:
for line in lines:
line = line.strip()
if line.startswith("**"):
section = line.strip("*")
yield _format_section(section)
elif line:
yield clean_line(line)
def build_parser() -> argparse.ArgumentParser:
argument_parser = argparse.ArgumentParser(description="Manage Schemathesis changelog.")
subparsers = argument_parser.add_subparsers(title="subcommands", dest="subcommand")
# `bump` subcommand
bump_parser = subparsers.add_parser("bump", help="Bump the version of the changelog")
bump_parser.add_argument("new_version", type=str, help="The new version number to bump to")
# `md` subcommand
md_parser = subparsers.add_parser("md", help="Transform the changelog for a specific version into markdown style")
md_parser.add_argument("version", type=str, help="The version to transform into markdown")
return argument_parser
if __name__ == "__main__":
parser = build_parser()
args = parser.parse_args()
if args.subcommand == "bump":
bump(args.new_version)
elif args.subcommand == "md":
to_markdown(args.version)
else:
parser.error("Missing subcommand")
| 0.599954 | 0.165425 |
<p align="center">
<em>Discover API-breaking payloads, keep API documentation up-to-date, and increase confidence in your API</em>
</p>
<p align="center">
<a href="https://github.com/schemathesis/schemathesis/actions" target="_blank">
<img src="https://github.com/schemathesis/schemathesis/actions/workflows/build.yml/badge.svg" alt="Build">
</a>
<a href="https://codecov.io/gh/schemathesis/schemathesis/branch/master" target="_blank">
<img src="https://codecov.io/gh/schemathesis/schemathesis/branch/master/graph/badge.svg" alt="Coverage">
</a>
<a href="https://pypi.org/project/schemathesis/" target="_blank">
<img src="https://img.shields.io/pypi/v/schemathesis.svg" alt="Version">
</a>
<a href="https://pypi.org/project/schemathesis/" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/schemathesis.svg" alt="Python versions">
</a>
<a href="https://discord.gg/R9ASRAmHnA" target="_blank">
<img src="https://img.shields.io/discord/938139740912369755" alt="Discord">
</a>
<a href="https://opensource.org/licenses/MIT" target="_blank">
<img src="https://img.shields.io/pypi/l/schemathesis.svg" alt="License">
</a>
</p>
---
**Documentation**: <a href="https://schemathesis.readthedocs.io/en/stable/" target="_blank">https://schemathesis.readthedocs.io/en/stable/ </a>
**Chat**: <a href="https://discord.gg/R9ASRAmHnA" target="_blank">https://discord.gg/R9ASRAmHnA </a>
---
Schemathesis is a specification-based testing tool for OpenAPI and GraphQL apps based on the powerful <a href="https://hypothesis.works/" target="_blank">Hypothesis</a> framework.
Here are the key features:
- **OpenAPI & GraphQL**: Test a wide range of APIs with ease, regardless of the specification used.
- **Positive & Negative Tests**: Ensure your API handles valid and invalid inputs, incl. unexpected ones.
- **Stateful Testing**: Automatically generate sequences of API
requests where subsequent requests build on previous ones for
testing complex and interdependent scenarios.
- **Session Replay**: Quickly store and replay test sessions to easily investigate and resolve issues.
- **Targeted Testing**: Guide data generation towards specific metrics
like response time or size. Uncover performance or resource usage
issues and optimize API behavior under different conditions.
- **Python Integration**: Utilize native ASGI/WSGI support for faster testing your Python applications.
- **Customization**: Tune data generation, API response verification, and testing process to fit your needs.
- **CI Integration**: Run tests on every code change with Docker image
and [GitHub Action](https://github.com/schemathesis/action).
## Testimonials
"_The world needs modern, spec-based API tests, so we can deliver APIs as-designed. Schemathesis is the right tool for that job._"
<div>Emmanuel Paraskakis - <strong>Level 250</strong></div>
---
"_Schemathesis is the only sane way to thoroughly test an API._"
<div>Zdenek Nemec - <strong>superface.ai</strong></div>
---
"_The tool is absolutely amazing as it can do the negative scenario testing instead of me and much faster! Before I was doing the same tests in Postman client. But it's much slower and brings maintenance burden._"
<div>LudΔk NovΓ½ - <strong>JetBrains</strong></div>
---
"_Schemathesis is the best tool for fuzz testing of REST API on the market. We are at Red Hat use it for examining our applications in functional and integrations testing levels._"
<div>Dmitry Misharov - <strong>RedHat</strong></div>
---
## How does it work?
Schemathesis uses your API's schema to generate both valid and invalid
test scenarios, helping you verify API compliance and catch potential
issues. It also verifies examples from the schema itself.
Schemathesis generates high quality, diverse test data based on novel
techniques like [Swarm
testing](https://dl.acm.org/doi/10.1145/2338965.2336763) or [Schema
fuzzing](https://patricegodefroid.github.io/public_psfiles/fse2020.pdf),
ensuring that your API is thoroughly tested and even the most elusive
bugs are uncovered.
It's a versatile tool that works with any language, as long as you have
an API schema in a supported format.
Learn more about how it works in our [research
paper](https://arxiv.org/abs/2112.10328).
## Why use Schemathesis?
1. **Avoid Crashes**: Discover API-breaking payloads and avoid crashes, database corruption, and hangs.
2. **Keep API Documentation Up-to-Date**: With Schemathesis, you never have to worry about API consumers using outdated specifications or incorrect payload examples.
3. **Easy Debugging**: Schemathesis provides you with a detailed failure report, along with a single cURL command to help you reproduce the problem instantly.
4. **Increased Confidence in API Stability**: By thoroughly testing your API with Schemathesis, you can have peace of mind knowing that your API is functioning as intended.
5. **Thorough Testing Coverage**: Schemathesis generates a large number of scenarios to test your API against, giving you a comprehensive view of its behavior and potential issues.
6. **Time-Saving**: Schemathesis streamlines API testing, saving your time for other tasks.
## Getting started
Schemathesis can be used as a CLI, a Python library, or as a [SaaS](https://schemathesis.io/?utm_source=github).
- **CLI**: Quick and easy way to get started, for those who prefer the command line.
- **Python Library**: More control and customization, for developers integrating with their codebase.
- **SaaS**: No setup or installation, if you prefer an all-in-one solution with great visuals. Free tier included.
## Installation
```bash
python -m pip install schemathesis
```
This command installs the `st` entrypoint.
You can also use our Docker image without installing Schemathesis as a Python package:
```bash
docker pull schemathesis/schemathesis:stable
```
## Example
### Command line
```bash
st run --checks all https://example.schemathesis.io/openapi.json
# Or
docker run schemathesis/schemathesis:stable \
run --checks all https://example.schemathesis.io/openapi.json
```
### Python tests
```python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.parametrize()
def test_api(case):
case.call_and_validate()
```
Choose CLI for simplicity or Python package for greater flexibility. Both options run extensive tests and report failures with reproduction instructions.
π‘ See a complete working example project in the [/example](https://github.com/schemathesis/schemathesis/tree/master/example) directory.π‘
## GitHub Actions
If you use GitHub Actions, there is a native [GitHub app](https://github.com/apps/schemathesis) that reports test results directly to your pull requests.
```yaml
api-tests:
runs-on: ubuntu-20.04
steps:
# Runs Schemathesis tests with all checks enabled
- uses: schemathesis/action@v1
with:
# Your API schema location
schema: "http://localhost:5000/api/openapi.json"
# OPTIONAL. Your Schemathesis.io token
token: ${{ secrets.SCHEMATHESIS_TOKEN }}
```
Check our [GitHub Action](https://github.com/schemathesis/action) for more details.
## Let's make it better together π€
We're always looking to make Schemathesis better, and your feedback is
a crucial part of that journey! If you've got a few minutes, we'd love
to hear your thoughts on your experience using Schemathesis.
Just follow [this link](https://forms.gle/kJ4hSxc1Yp6Ga96t5) to let us know what you think π¬
Thanks for helping us make Schemathesis even better! π
## Commercial support
For assistance with integrating Schemathesis into your company workflows or improving its effectiveness, reach out to our support team at <a href="mailto:[email protected]">[email protected]</a>.
Additionally, we offer commercial support for those looking for extra assurance and priority assistance.
## Contributing
Any contribution to development, testing, or any other area is highly
appreciated and useful to the project. For guidance on how to contribute
to Schemathesis, see the [contributing guidelines](https://github.com/schemathesis/schemathesis/blob/master/CONTRIBUTING.rst).
## Additional content
- [Deriving Semantics-Aware Fuzzers from Web API Schemas](https://arxiv.org/abs/2112.10328) by **@Zac-HD** and **@Stranger6667**
- [An article](https://dygalo.dev/blog/schemathesis-property-based-testing-for-api-schemas/) about Schemathesis by **@Stranger6667**
- [Effective API schemas testing](https://youtu.be/VVLZ25JgjD4) from DevConf.cz by **@Stranger6667**
- [How to use Schemathesis to test Flask API in GitHub Actions](https://notes.lina-is-here.com/2022/08/04/schemathesis-docker-compose.html) by **@lina-is-here**
- [Testing APIFlask with schemathesis](http://blog.pamelafox.org/2023/02/testing-apiflask-with-schemathesis.html) by **@pamelafox**
- [A video](https://www.youtube.com/watch?v=9FHRwrv-xuQ) from EuroPython 2020 by **@hultner**
- [Schemathesis tutorial](https://appdev.consulting.redhat.com/tracks/contract-first/automated-testing-with-schemathesis.html) with an accompanying [video](https://www.youtube.com/watch?v=4r7OC-lBKMg) by Red Hat
- [Using Hypothesis and Schemathesis to Test FastAPI](https://testdriven.io/blog/fastapi-hypothesis/) by **@amalshaji**
- [A tutorial](https://habr.com/ru/company/oleg-bunin/blog/576496/) (RUS) about Schemathesis by **@Stranger6667**
## License
This project is licensed under the terms of the [MIT license](https://opensource.org/licenses/MIT).
|
schemathesis
|
/schemathesis-3.19.2.tar.gz/schemathesis-3.19.2/README.md
|
README.md
|
python -m pip install schemathesis
docker pull schemathesis/schemathesis:stable
st run --checks all https://example.schemathesis.io/openapi.json
# Or
docker run schemathesis/schemathesis:stable \
run --checks all https://example.schemathesis.io/openapi.json
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.parametrize()
def test_api(case):
case.call_and_validate()
api-tests:
runs-on: ubuntu-20.04
steps:
# Runs Schemathesis tests with all checks enabled
- uses: schemathesis/action@v1
with:
# Your API schema location
schema: "http://localhost:5000/api/openapi.json"
# OPTIONAL. Your Schemathesis.io token
token: ${{ secrets.SCHEMATHESIS_TOKEN }}
| 0.60871 | 0.938688 |
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project, and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
|
schemathesis
|
/schemathesis-3.19.2.tar.gz/schemathesis-3.19.2/CODE_OF_CONDUCT.md
|
CODE_OF_CONDUCT.md
|
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project, and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
| 0.51879 | 0.646244 |
Continuous Integration
======================
Welcome to the Schemathesis CI guide! This document provides all the necessary information to integrate Schemathesis
into your Continuous Integration workflows.
Quickstart
----------
You can use these code samples to test your API in a pull request or run tests against a publicly resolvable API.
If you need to start your API server locally before testing, check out the `Preparing your App`_ section below.
GitHub Actions
~~~~~~~~~~~~~~
.. important::
We have a native `GitHub app`_ that reports test results directly to your pull requests.
.. code-block:: yaml
api-tests:
runs-on: ubuntu-20.04
steps:
# Runs Schemathesis tests with all checks enabled
- uses: schemathesis/action@v1
with:
# Your API schema location
schema: 'http://localhost:5000/api/openapi.json'
# OPTIONAL. Your Schemathesis.io token
token: ${{ secrets.SCHEMATHESIS_TOKEN }}
For the fully working example, check |no-build.yml|_ in the repository.
.. |no-build.yml| replace:: ``.github/workflows/example-no-build.yml``
.. _no-build.yml: https://github.com/schemathesis/schemathesis/blob/master/.github/workflows/example-no-build.yml
If you enabled PR comments via our `GitHub app`_, you'll see a test report once your pipeline is finished:
.. image:: https://raw.githubusercontent.com/schemathesis/schemathesis/master/img/service_github_report.png
GitLab CI
~~~~~~~~~
.. code-block:: yaml
api-tests:
stage: test
image:
name: schemathesis/schemathesis:stable
entrypoint: [""]
variables:
# API Schema location
API_SCHEMA: 'http://localhost:5000/api/openapi.json'
# OPTIONAL. Your Schemathesis.io token
SCHEMATHESIS_TOKEN: ${{ secrets.SCHEMATHESIS_TOKEN }}
script:
- st run $API_SCHEMA --checks=all --report
How does it work?
------------------
Schemathesis works over HTTP and expects that your application is reachable from the CI environment.
You can prepare your application in the same CI as the previous step or run it against a staging environment.
Preparing your App
------------------
Start API before testing
~~~~~~~~~~~~~~~~~~~~~~~~
It is common to have a test suite as a part of the application repo. For this scenario, you will need to build your app first.
The application could be built in **any programming language**, Schemathesis expects only its API schema.
Here is a GitHub Actions workflow for a sample `Python app`_:
.. code-block:: yaml
api-tests:
runs-on: ubuntu-20.04
steps:
# Gets a copy of the source code in your repository before running API tests
- uses: actions/[email protected]
- uses: actions/setup-python@v4
with:
python-version: '3.10'
# Installs project's dependencies
- run: pip install -r requirements.txt
# Start the API in the background
- run: python main.py &
# Runs Schemathesis tests with all checks enabled
- uses: schemathesis/action@v1
with:
# Your API schema location
schema: 'http://localhost:5000/api/openapi.json'
# OPTIONAL. Your Schemathesis.io token
token: ${{ secrets.SCHEMATHESIS_TOKEN }}
.. note::
This example expects the API schema available at ``http://localhost:5000/api/openapi.json`` inside the CI environment.
For the fully working example, check |build.yml|_ in the repository.
.. |build.yml| replace:: ``.github/workflows/example-build.yml``
.. _build.yml: https://github.com/schemathesis/schemathesis/blob/master/.github/workflows/example-build.yml
API schema in a file
~~~~~~~~~~~~~~~~~~~~
If you store your API schema in a file, use its file path for the ``API_SCHEMA`` environment variable.
Set your API base path to ``SCHEMATHESIS_BASE_URL``:
.. code-block:: yaml
api-tests:
runs-on: ubuntu-20.04
steps:
# Runs positive Schemathesis tests
- uses: schemathesis/action@v1
with:
# A local API schema location
schema: './docs/openapi.json'
# API base URL
base-url: 'http://127.0.0.1:8080/api/v2/'
# OPTIONAL. Your Schemathesis.io token
token: ${{ secrets.SCHEMATHESIS_TOKEN }}
.. _Python app: https://github.com/schemathesis/schemathesis/tree/master/example
.. _GitHub app: https://github.com/apps/schemathesis
|
schemathesis
|
/schemathesis-3.19.2.tar.gz/schemathesis-3.19.2/docs/continuous_integration.rst
|
continuous_integration.rst
|
Continuous Integration
======================
Welcome to the Schemathesis CI guide! This document provides all the necessary information to integrate Schemathesis
into your Continuous Integration workflows.
Quickstart
----------
You can use these code samples to test your API in a pull request or run tests against a publicly resolvable API.
If you need to start your API server locally before testing, check out the `Preparing your App`_ section below.
GitHub Actions
~~~~~~~~~~~~~~
.. important::
We have a native `GitHub app`_ that reports test results directly to your pull requests.
.. code-block:: yaml
api-tests:
runs-on: ubuntu-20.04
steps:
# Runs Schemathesis tests with all checks enabled
- uses: schemathesis/action@v1
with:
# Your API schema location
schema: 'http://localhost:5000/api/openapi.json'
# OPTIONAL. Your Schemathesis.io token
token: ${{ secrets.SCHEMATHESIS_TOKEN }}
For the fully working example, check |no-build.yml|_ in the repository.
.. |no-build.yml| replace:: ``.github/workflows/example-no-build.yml``
.. _no-build.yml: https://github.com/schemathesis/schemathesis/blob/master/.github/workflows/example-no-build.yml
If you enabled PR comments via our `GitHub app`_, you'll see a test report once your pipeline is finished:
.. image:: https://raw.githubusercontent.com/schemathesis/schemathesis/master/img/service_github_report.png
GitLab CI
~~~~~~~~~
.. code-block:: yaml
api-tests:
stage: test
image:
name: schemathesis/schemathesis:stable
entrypoint: [""]
variables:
# API Schema location
API_SCHEMA: 'http://localhost:5000/api/openapi.json'
# OPTIONAL. Your Schemathesis.io token
SCHEMATHESIS_TOKEN: ${{ secrets.SCHEMATHESIS_TOKEN }}
script:
- st run $API_SCHEMA --checks=all --report
How does it work?
------------------
Schemathesis works over HTTP and expects that your application is reachable from the CI environment.
You can prepare your application in the same CI as the previous step or run it against a staging environment.
Preparing your App
------------------
Start API before testing
~~~~~~~~~~~~~~~~~~~~~~~~
It is common to have a test suite as a part of the application repo. For this scenario, you will need to build your app first.
The application could be built in **any programming language**, Schemathesis expects only its API schema.
Here is a GitHub Actions workflow for a sample `Python app`_:
.. code-block:: yaml
api-tests:
runs-on: ubuntu-20.04
steps:
# Gets a copy of the source code in your repository before running API tests
- uses: actions/[email protected]
- uses: actions/setup-python@v4
with:
python-version: '3.10'
# Installs project's dependencies
- run: pip install -r requirements.txt
# Start the API in the background
- run: python main.py &
# Runs Schemathesis tests with all checks enabled
- uses: schemathesis/action@v1
with:
# Your API schema location
schema: 'http://localhost:5000/api/openapi.json'
# OPTIONAL. Your Schemathesis.io token
token: ${{ secrets.SCHEMATHESIS_TOKEN }}
.. note::
This example expects the API schema available at ``http://localhost:5000/api/openapi.json`` inside the CI environment.
For the fully working example, check |build.yml|_ in the repository.
.. |build.yml| replace:: ``.github/workflows/example-build.yml``
.. _build.yml: https://github.com/schemathesis/schemathesis/blob/master/.github/workflows/example-build.yml
API schema in a file
~~~~~~~~~~~~~~~~~~~~
If you store your API schema in a file, use its file path for the ``API_SCHEMA`` environment variable.
Set your API base path to ``SCHEMATHESIS_BASE_URL``:
.. code-block:: yaml
api-tests:
runs-on: ubuntu-20.04
steps:
# Runs positive Schemathesis tests
- uses: schemathesis/action@v1
with:
# A local API schema location
schema: './docs/openapi.json'
# API base URL
base-url: 'http://127.0.0.1:8080/api/v2/'
# OPTIONAL. Your Schemathesis.io token
token: ${{ secrets.SCHEMATHESIS_TOKEN }}
.. _Python app: https://github.com/schemathesis/schemathesis/tree/master/example
.. _GitHub app: https://github.com/apps/schemathesis
| 0.862757 | 0.485966 |
Targeted property-based testing
===============================
Schemathesis supports targeted property-based testing via utilizing ``hypothesis.target`` inside its runner and provides
an API to guide data generation towards certain pre-defined goals:
- ``response_time``. Hypothesis will try to generate input that will more likely to have higher response time;
To illustrate this feature, consider the following AioHTTP request handler, that contains a hidden performance problem -
the more zeroes are in the input number, the slower it works, and if there are more than 10 zeroes, it will cause an internal
server error:
.. code:: python
import asyncio
from aiohttp import web
async def performance(request: web.Request) -> web.Response:
decoded = await request.json()
number = str(decoded).count("0")
if number > 0:
# emulate hard work
await asyncio.sleep(0.01 * number)
if number > 10:
raise web.HTTPInternalServerError
return web.json_response({"slow": True})
Let's take a look if Schemathesis can discover this issue and how much time it will take:
.. code:: bash
$ st run --hypothesis-max-examples=100000 http://127.0.0.1:8081/schema.yaml
...
1. Received a response with 5xx status code: 500
Check : not_a_server_error
Body : 58150920460703009030426716484679203200
Run this Python code to reproduce this failure:
requests.post('http://127.0.0.1:8081/api/performance', json=58150920460703009030426716484679203200)
Or add this option to your command line parameters: --hypothesis-seed=240368931405400688094965957483327791742
================================================== SUMMARY ==================================================
Performed checks:
not_a_server_error 67993 / 68041 passed FAILED
============================================ 1 failed in 662.16s ===========================================
And with targeted testing (``.hypothesis`` directory was removed between these test runs to avoid reusing results):
.. code:: bash
$ st run --target=response_time --hypothesis-max-examples=100000 http://127.0.0.1:8081/schema.yaml
...
1. Received a response with 5xx status code: 500
Check : not_a_server_error
Body : 2600050604444474172950385505254500000
Run this Python code to reproduce this failure:
requests.post('http://127.0.0.1:8081/api/performance', json=2600050604444474172950385505254500000)
Or add this option to your command line parameters: --hypothesis-seed=340229547842147149729957578683815058325
================================================== SUMMARY ==================================================
Performed checks:
not_a_server_error 22039 / 22254 passed FAILED
============================================ 1 failed in 305.50s ===========================================
This behavior is reproducible in general, but not guaranteed due to the randomness of data generation. However, it shows
a significant testing time reduction, especially on a large number of examples.
Hypothesis `documentation <https://hypothesis.readthedocs.io/en/latest/details.html#targeted-example-generation>`_ provides a detailed explanation of what targeted property-based testing is.
Custom targets
~~~~~~~~~~~~~~
You can register your own targets with the ``schemathesis.target`` decorator. The function should accept ``schemathesis.targets.TargetContext`` and return a float value:
.. code:: python
import schemathesis
@schemathesis.target
def new_target(context) -> float:
return float(len(context.response.content))
Such a function will cause Hypothesis to generate input that is more likely to produce larger responses.
|
schemathesis
|
/schemathesis-3.19.2.tar.gz/schemathesis-3.19.2/docs/targeted.rst
|
targeted.rst
|
Targeted property-based testing
===============================
Schemathesis supports targeted property-based testing via utilizing ``hypothesis.target`` inside its runner and provides
an API to guide data generation towards certain pre-defined goals:
- ``response_time``. Hypothesis will try to generate input that will more likely to have higher response time;
To illustrate this feature, consider the following AioHTTP request handler, that contains a hidden performance problem -
the more zeroes are in the input number, the slower it works, and if there are more than 10 zeroes, it will cause an internal
server error:
.. code:: python
import asyncio
from aiohttp import web
async def performance(request: web.Request) -> web.Response:
decoded = await request.json()
number = str(decoded).count("0")
if number > 0:
# emulate hard work
await asyncio.sleep(0.01 * number)
if number > 10:
raise web.HTTPInternalServerError
return web.json_response({"slow": True})
Let's take a look if Schemathesis can discover this issue and how much time it will take:
.. code:: bash
$ st run --hypothesis-max-examples=100000 http://127.0.0.1:8081/schema.yaml
...
1. Received a response with 5xx status code: 500
Check : not_a_server_error
Body : 58150920460703009030426716484679203200
Run this Python code to reproduce this failure:
requests.post('http://127.0.0.1:8081/api/performance', json=58150920460703009030426716484679203200)
Or add this option to your command line parameters: --hypothesis-seed=240368931405400688094965957483327791742
================================================== SUMMARY ==================================================
Performed checks:
not_a_server_error 67993 / 68041 passed FAILED
============================================ 1 failed in 662.16s ===========================================
And with targeted testing (``.hypothesis`` directory was removed between these test runs to avoid reusing results):
.. code:: bash
$ st run --target=response_time --hypothesis-max-examples=100000 http://127.0.0.1:8081/schema.yaml
...
1. Received a response with 5xx status code: 500
Check : not_a_server_error
Body : 2600050604444474172950385505254500000
Run this Python code to reproduce this failure:
requests.post('http://127.0.0.1:8081/api/performance', json=2600050604444474172950385505254500000)
Or add this option to your command line parameters: --hypothesis-seed=340229547842147149729957578683815058325
================================================== SUMMARY ==================================================
Performed checks:
not_a_server_error 22039 / 22254 passed FAILED
============================================ 1 failed in 305.50s ===========================================
This behavior is reproducible in general, but not guaranteed due to the randomness of data generation. However, it shows
a significant testing time reduction, especially on a large number of examples.
Hypothesis `documentation <https://hypothesis.readthedocs.io/en/latest/details.html#targeted-example-generation>`_ provides a detailed explanation of what targeted property-based testing is.
Custom targets
~~~~~~~~~~~~~~
You can register your own targets with the ``schemathesis.target`` decorator. The function should accept ``schemathesis.targets.TargetContext`` and return a float value:
.. code:: python
import schemathesis
@schemathesis.target
def new_target(context) -> float:
return float(len(context.response.content))
Such a function will cause Hypothesis to generate input that is more likely to produce larger responses.
| 0.774583 | 0.621225 |
Compatibility
=============
By default, Schemathesis is strict on Open API spec interpretation, but other 3rd-party tools often are more flexible
and not always comply with the spec.
Using FastAPI
-------------
`FastAPI <https://github.com/tiangolo/fastapi>`_ uses `pydantic <https://github.com/samuelcolvin/pydantic>`_ for JSON Schema
generation, and it produces Draft 7 compatible schemas. But Open API 2 / 3.0.x use earlier versions of JSON Schema (Draft 4 and Wright Draft 00 respectively), which leads
to incompatibilities when Schemathesis parses input schema.
It is a `known issue <https://github.com/tiangolo/fastapi/issues/240>`_ on the FastAPI side,
and Schemathesis provides a way to handle such schemas. The idea is to convert Draft 7 keywords syntax to Draft 4.
To use it, you need to add this code before you load your schema with Schemathesis:
.. code:: python
import schemathesis
# will install all available compatibility fixups.
schemathesis.fixups.install()
# You can provide a list of fixup names as the first argument
# schemathesis.fixups.install(["fast_api"])
If you use the Command Line Interface, then you can utilize the ``--fixups=all`` option.
UTF-8 BOM
---------
Some web servers may prefix JSON with UTF-8 Byte Order Mark - ``\ufeff``, which is explicitly forbidden by RFC 7159 (JSON).
Enabling the ``utf8_bom`` fixup allows Schemathesis to process such responses by removing this mark from responses.
|
schemathesis
|
/schemathesis-3.19.2.tar.gz/schemathesis-3.19.2/docs/compatibility.rst
|
compatibility.rst
|
Compatibility
=============
By default, Schemathesis is strict on Open API spec interpretation, but other 3rd-party tools often are more flexible
and not always comply with the spec.
Using FastAPI
-------------
`FastAPI <https://github.com/tiangolo/fastapi>`_ uses `pydantic <https://github.com/samuelcolvin/pydantic>`_ for JSON Schema
generation, and it produces Draft 7 compatible schemas. But Open API 2 / 3.0.x use earlier versions of JSON Schema (Draft 4 and Wright Draft 00 respectively), which leads
to incompatibilities when Schemathesis parses input schema.
It is a `known issue <https://github.com/tiangolo/fastapi/issues/240>`_ on the FastAPI side,
and Schemathesis provides a way to handle such schemas. The idea is to convert Draft 7 keywords syntax to Draft 4.
To use it, you need to add this code before you load your schema with Schemathesis:
.. code:: python
import schemathesis
# will install all available compatibility fixups.
schemathesis.fixups.install()
# You can provide a list of fixup names as the first argument
# schemathesis.fixups.install(["fast_api"])
If you use the Command Line Interface, then you can utilize the ``--fixups=all`` option.
UTF-8 BOM
---------
Some web servers may prefix JSON with UTF-8 Byte Order Mark - ``\ufeff``, which is explicitly forbidden by RFC 7159 (JSON).
Enabling the ``utf8_bom`` fixup allows Schemathesis to process such responses by removing this mark from responses.
| 0.849722 | 0.335664 |
Schemathesis: Property-based testing for API schemas
====================================================
Schemathesis is a specification-centric API testing tool for Open API and GraphQL-based applications.
It reads the application schema and generates test cases, which will ensure that your application is compliant with its schema and never crashes.
The application under test could be written in any language; the only thing you need is a valid API schema in a supported format.
Simple to use and yet powerful to uncover hard-to-find errors thanks to the property-based testing approach backed by state-of-the-art `Hypothesis <http://hypothesis.works/>`_ library.
You can use Schemathesis in the command line directly:
.. code:: bash
st run https://example.schemathesis.io/openapi.json
Or via Docker:
.. code:: bash
docker run schemathesis/schemathesis:stable run https://example.schemathesis.io/openapi.json
Or in your Python tests:
.. code-block:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.parametrize()
def test_api(case):
case.call_and_validate()
Both examples above will run hundreds of requests against the API under test and report all found failures and inconsistencies along with instructions to reproduce them.
.. note::
You can also use our `SaaS <https://app.schemathesis.io/auth/sign-up/?utm_source=oss_docs&utm_content=index_note>`_ to run more comprehensive tests and visualise the outcomes!
Features
--------
- Open API: Schema conformance, explicit examples, stateful testing;
- GraphQL: queries generation;
- Multi-worker test execution;
- Storing and replaying tests;
- ASGI / WSGI support;
- Generated code samples (cURL, Python);
- Docker image;
- Customizable checks & test generation
.. note::
π Join our `Discord <https://discord.gg/R9ASRAmHnA>`_, we'd love to hear your feedback π
User's Guide
------------
.. toctree::
:maxdepth: 2
introduction
cli
python
continuous_integration
service
auth
contrib
stateful
how
compatibility
examples
graphql
targeted
extending
Support
-------
If you want to integrate Schemathesis into your company workflows or improve its effectiveness, feel free to reach out to `[email protected]`.
Schemathesis.io also runs workshops about effective API testing. `Signup here <https://forms.gle/epkovRdQNMCYh2Ax8>`_
Resources
---------
- `Deriving Semantics-Aware Fuzzers from Web API Schemas <https://arxiv.org/abs/2112.10328>`_ by **Zac-HD** and **@Stranger6667**
- `An article <https://dygalo.dev/blog/schemathesis-property-based-testing-for-api-schemas/>`_ about Schemathesis by **@Stranger6667**
- `Effective API schemas testing <https://youtu.be/VVLZ25JgjD4>`_ from DevConf.cz by **@Stranger6667**
- `How to use Schemathesis to test Flask API in GitHub Actions <https://notes.lina-is-here.com/2022/08/04/schemathesis-docker-compose.html>`_ by **@lina-is-here**
- `A video <https://www.youtube.com/watch?v=9FHRwrv-xuQ>`_ from EuroPython 2020 by **@hultner**
- `Schemathesis tutorial <https://appdev.consulting.redhat.com/tracks/contract-first/automated-testing-with-schemathesis.html>`_ with an accompanying `video <https://www.youtube.com/watch?v=4r7OC-lBKMg>`_ by Red Hat
- `Using Hypothesis and Schemathesis to Test FastAPI <https://testdriven.io/blog/fastapi-hypothesis/>`_ by **@amalshaji**
Additional notes
----------------
.. toctree::
:maxdepth: 2
recipes
api
faq
changelog
|
schemathesis
|
/schemathesis-3.19.2.tar.gz/schemathesis-3.19.2/docs/index.rst
|
index.rst
|
Schemathesis: Property-based testing for API schemas
====================================================
Schemathesis is a specification-centric API testing tool for Open API and GraphQL-based applications.
It reads the application schema and generates test cases, which will ensure that your application is compliant with its schema and never crashes.
The application under test could be written in any language; the only thing you need is a valid API schema in a supported format.
Simple to use and yet powerful to uncover hard-to-find errors thanks to the property-based testing approach backed by state-of-the-art `Hypothesis <http://hypothesis.works/>`_ library.
You can use Schemathesis in the command line directly:
.. code:: bash
st run https://example.schemathesis.io/openapi.json
Or via Docker:
.. code:: bash
docker run schemathesis/schemathesis:stable run https://example.schemathesis.io/openapi.json
Or in your Python tests:
.. code-block:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.parametrize()
def test_api(case):
case.call_and_validate()
Both examples above will run hundreds of requests against the API under test and report all found failures and inconsistencies along with instructions to reproduce them.
.. note::
You can also use our `SaaS <https://app.schemathesis.io/auth/sign-up/?utm_source=oss_docs&utm_content=index_note>`_ to run more comprehensive tests and visualise the outcomes!
Features
--------
- Open API: Schema conformance, explicit examples, stateful testing;
- GraphQL: queries generation;
- Multi-worker test execution;
- Storing and replaying tests;
- ASGI / WSGI support;
- Generated code samples (cURL, Python);
- Docker image;
- Customizable checks & test generation
.. note::
π Join our `Discord <https://discord.gg/R9ASRAmHnA>`_, we'd love to hear your feedback π
User's Guide
------------
.. toctree::
:maxdepth: 2
introduction
cli
python
continuous_integration
service
auth
contrib
stateful
how
compatibility
examples
graphql
targeted
extending
Support
-------
If you want to integrate Schemathesis into your company workflows or improve its effectiveness, feel free to reach out to `[email protected]`.
Schemathesis.io also runs workshops about effective API testing. `Signup here <https://forms.gle/epkovRdQNMCYh2Ax8>`_
Resources
---------
- `Deriving Semantics-Aware Fuzzers from Web API Schemas <https://arxiv.org/abs/2112.10328>`_ by **Zac-HD** and **@Stranger6667**
- `An article <https://dygalo.dev/blog/schemathesis-property-based-testing-for-api-schemas/>`_ about Schemathesis by **@Stranger6667**
- `Effective API schemas testing <https://youtu.be/VVLZ25JgjD4>`_ from DevConf.cz by **@Stranger6667**
- `How to use Schemathesis to test Flask API in GitHub Actions <https://notes.lina-is-here.com/2022/08/04/schemathesis-docker-compose.html>`_ by **@lina-is-here**
- `A video <https://www.youtube.com/watch?v=9FHRwrv-xuQ>`_ from EuroPython 2020 by **@hultner**
- `Schemathesis tutorial <https://appdev.consulting.redhat.com/tracks/contract-first/automated-testing-with-schemathesis.html>`_ with an accompanying `video <https://www.youtube.com/watch?v=4r7OC-lBKMg>`_ by Red Hat
- `Using Hypothesis and Schemathesis to Test FastAPI <https://testdriven.io/blog/fastapi-hypothesis/>`_ by **@amalshaji**
Additional notes
----------------
.. toctree::
:maxdepth: 2
recipes
api
faq
changelog
| 0.820972 | 0.586049 |
Authentication
==============
In this section, we'll cover how to use Schemathesis to test APIs that require authentication.
We'll start with the basics of setting authentication credentials manually using headers, cookies, and query strings.
Then, we'll move on to more advanced topics, including HTTP Basic, Digest Authentication, custom authentication mechanisms, and reusing sessions in Python tests.
Setting credentials
-------------------
To set authentication credentials manually, you can pass a key-value pairs to Schemathesis when running tests.
Here's an example command for setting a custom header or cookie using the CLI:
.. code:: text
st run -H "Authorization: Bearer TOKEN" ...
st run -H "Cookie: session=SECRET" ...
You can also provide multiple headers by using the ``-H`` option multiple times:
.. code:: text
st run -H "Authorization: Bearer TOKEN" -H "X-Session-Id: SECRET" ...
.. note::
Query string authentication is not yet supported in the Schemathesis CLI, however, you can use custom authentication mechanisms to set authentication in a query string parameter.
Details on how to do this are described in the :ref:`Custom Authentication <custom-auth>` section below.
For Python tests you can set a header, cookie or a query parameter inside your test function:
.. code-block:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.parametrize()
def test_api(case):
# Header
case.call_and_validate(headers={"Authorization": "Bearer TOKEN"})
# Cookie
case.call_and_validate(cookies={"session": "SECRET"})
# Query parameter
case.call_and_validate(params={"Api-Key": "KEY"})
Built-In Authentication mechanisms
----------------------------------
`HTTP Basic <https://datatracker.ietf.org/doc/html/rfc7617>`_ and `HTTP Digest <https://datatracker.ietf.org/doc/html/rfc7616>`_ are two common authentication schemes supported by Schemathesis out of the box.
.. code:: text
st run --auth user:pass --auth-type=basic ...
st run --auth user:pass --auth-type=digest ...
In Python tests, you can use the `requests <https://github.com/psf/requests>`_ library to send requests with HTTP Basic or HTTP Digest authentication.
You can pass the authentication credentials using the ``auth`` arguments of the ``call`` or ``call_and_validate`` methods:
.. code-block:: python
import schemathesis
from requests.auth import HTTPDigestAuth
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.parametrize()
def test_api(case):
# HTTP Basic
case.call_and_validate(auth=("user", "password"))
# HTTP Digest
case.call_and_validate(auth=HTTPDigestAuth("user", "password"))
.. _custom-auth:
Custom Authentication
---------------------
In addition to the built-in authentication options, Schemathesis also allows you to implement your own custom authentication mechanisms in Python.
It can be useful if you are working with an API that uses a custom authentication method.
This section will explain how to define custom authentication mechanisms and use them in CLI and Python tests.
Implementation
~~~~~~~~~~~~~~
To implement a custom authentication mechanism, you need to create a Python class with two methods and plug it into Schemathesis.
The two methods your class should contain are:
- ``get``: This method should get the authentication data and return it.
- ``set``: This method should modify the generated test sample so that it contains the authentication data.
Here's an example of a simple custom authentication class. However, please note that this code alone will not work without the necessary registration steps, which will be described later in this section.
.. code:: python
import requests
# This is a real endpoint, try it out!
TOKEN_ENDPOINT = "https://example.schemathesis.io/api/token/"
USERNAME = "demo"
PASSWORD = "test"
class MyAuth:
def get(self, context):
response = requests.post(
TOKEN_ENDPOINT,
json={"username": USERNAME, "password": PASSWORD},
)
data = response.json()
return data["access_token"]
def set(self, case, data, context):
case.headers = case.headers or {}
case.headers["Authorization"] = f"Bearer {data}"
The ``get`` method sends a request to a token endpoint and returns the access token retrieved from the JSON response.
The ``set`` method modifies the generated ``Case`` instance so that it contains the authentication data, adding an ``Authorization`` header with the retrieved token.
The ``context`` argument contains a few attributes useful for the authentication process:
- ``context.operation``. API operation that is currently being tested
- ``context.app``. A Python application if the WSGI / ASGI integration is used
Using in CLI
~~~~~~~~~~~~
To use your custom authentication mechanism in the Schemathesis CLI, you need to register it globally. Here's an example of how to do that:
.. code:: python
import schemathesis
@schemathesis.auth()
class MyAuth:
# Here goes your implementation
...
Put the code above to the ``hooks.py`` file and extend your command via the ``SCHEMATHESIS_HOOKS`` environment variable:
.. code:: bash
$ SCHEMATHESIS_HOOKS=hooks
$ st run ...
.. note::
You can take a look at how to extend CLI :ref:`here <extend-cli>`
Using in Python tests
~~~~~~~~~~~~~~~~~~~~~
To use your custom authentication mechanism in Python tests, you also need to register it.
The registration process is similar to the global registration for CLI, but instead, you can register your auth implementation at the schema or test level.
The following example shows how to use auth only tests generated via the ``schema`` instance:
.. code:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.auth()
class MyAuth:
# Here goes your implementation
...
And this one shows auth applied only to the ``test_api`` function:
.. code:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
class MyAuth:
# Here goes your implementation
...
@schema.auth(MyAuth)
@schema.parametrize()
def test_api(case):
...
Conditional Authentication
~~~~~~~~~~~~~~~~~~~~~~~~~~
Schemathesis offers a way to apply authentication to only a specific set of API operations during testing.
This is helpful when you need to test different authentication types for different API operations or when the API has a combination of authenticated and unauthenticated endpoints.
Multiple filters can be combined and applied to include or exclude API operations based on exact values, regular expressions, or custom functions.
Here is how you can apply auth to all API operations with the ``/users/`` path, but exclude the ``POST`` method.
.. code:: python
import schemathesis
@schemathesis.auth().apply_to(path="/users/").skip_for(method="POST")
class MyAuth:
# Here goes your implementation
...
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.auth(MyAuth).apply_to(path="/users/").skip_for(method="POST")
@schema.parametrize()
def test_api(case):
...
.. note::
This decorator syntax is supported only on Python 3.9+. For older Python versions you need to bind separate variables for each term.
Basic rules:
- ``apply_to`` applies authentication to all API operations that match the filter term
- ``skip_for`` skips authentication for all API operations that match the filter term
- All conditions within a filter term are combined with the ``AND`` logic
- Each ``apply_to`` and ``skip_for`` term is combined with the ``OR`` logic
- Both ``apply_to`` and ``skip_for`` use the same set of conditions as arguments
Conditions:
- ``path``: the path of the API operation without its ``basePath``.
- ``method``: the upper-cased HTTP method of the API operation
- ``name``: the name of the API operation, such as ``GET /users/`` or ``Query.getUsers``
- Each condition can take either a single string or a list of options as input
- You can also use a regular expression to match the conditions by adding ``_regex`` to the end of the condition and passing a string or a compiled regex.
Here are some examples for ``path``, other conditions works the same:
.. code:: python
import re
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
# Only `/users/`
@schema.auth().apply_to(path="/users/")
# Only `/users/` and `/orders/`
@schema.auth().apply_to(path=["/users/", "/orders/"])
# Only paths starting with `/u`
@schema.auth().apply_to(path_regex="^/u")
# Only paths starting with `/u` case insensitive
@schema.auth().apply_to(path_regex=re.compile("^/u", re.IGNORECASE))
# Only `GET /users/` or `POST /orders/`
@schema.auth().apply_to(
method="GET",
path="/users/",
).apply_to(
method="POST",
path="/orders/",
)
class MyAuth:
# Here goes your implementation
...
You can also use a custom function to determine whether to apply or skip authentication for a given operation.
The function should take an ``AuthContext`` instance and return a boolean value.
To use a custom function with ``apply_to`` or ``skip_for``, simply pass it as the first argument. For example:
.. code:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
def is_deprecated(ctx):
return ctx.operation.definition.get("deprecated") is True
# Skip auth for all deprecated API operations
@schema.auth().skip_for(is_deprecated)
class MyAuth:
# Here goes your implementation
...
Refreshing credentials
~~~~~~~~~~~~~~~~~~~~~~
By default, the authentication data from the ``get`` method is cached for a while (300 seconds by default).
To customize the caching behavior, pass the ``refresh_interval`` argument to the ``auth`` / ``register`` / ``apply`` functions.
This parameter specifies the number of seconds for which the authentication data will be cached after a non-cached ``get`` call.
To disable caching completely, set ``refresh_interval`` to None. For example, the following code sets the caching time to 600 seconds:
.. code:: python
import schemathesis
@schemathesis.auth(refresh_interval=600)
class MyAuth:
# Here goes your implementation
...
WSGI / ASGI support
~~~~~~~~~~~~~~~~~~~
If you are testing a Python app, you might want to use the WSGI / ASGI integrations and get authentication data from your application instance directly.
It could be done by using the ``context`` to get the application instance:
**FastAPI**:
.. code:: python
from myapp import app
from starlette_testclient import TestClient
schema = schemathesis.from_asgi("/openapi.json", app=app)
TOKEN_ENDPOINT = "/auth/token/"
USERNAME = "demo"
PASSWORD = "test"
@schema.auth()
class MyAuth:
def get(self, context):
client = TestClient(context.app)
response = client.post(
TOKEN_ENDPOINT, json={"username": USERNAME, "password": PASSWORD}
)
return response.json()["access_token"]
def set(self, case, data, context):
case.headers = case.headers or {}
case.headers["Authorization"] = f"Bearer {data}"
**Flask**:
.. code:: python
from myapp import app
import werkzeug
schema = schemathesis.from_wsgi("/openapi.json", app=app)
TOKEN_ENDPOINT = "/auth/token/"
USERNAME = "demo"
PASSWORD = "test"
@schema.auth()
class MyAuth:
def get(self, context):
client = werkzeug.Client(context.app)
response = client.post(
TOKEN_ENDPOINT, json={"username": USERNAME, "password": PASSWORD}
)
return response.json["access_token"]
def set(self, case, data, context):
case.headers = case.headers or {}
case.headers["Authorization"] = f"Bearer {data}"
Refresh tokens
~~~~~~~~~~~~~~
As auth provider class can hold additional state, you can use it to implement more complex authentication flows.
For example, you can use refresh tokens for authentication.
.. code:: python
import requests
import schemathesis
TOKEN_ENDPOINT = "https://auth.myapp.com/api/token/"
REFRESH_ENDPOINT = "https://auth.myapp.com/api/refresh/"
USERNAME = "demo"
PASSWORD = "test"
@schemathesis.auth()
class MyAuth:
def __init__(self):
self.refresh_token = None
def get(self, context):
if self.refresh_token is not None:
return self.refresh(context)
return self.login(context)
def login(self, context):
response = requests.post(
TOKEN_ENDPOINT,
json={"username": USERNAME, "password": PASSWORD},
)
data = response.json()
self.refresh_token = data["refresh_token"]
return data["access_token"]
def refresh(self, context):
response = requests.post(
REFRESH_ENDPOINT,
headers={"Authorization": f"Bearer {self.refresh_token}"},
)
data = response.json()
self.refresh_token = data["refresh_token"]
return data["access_token"]
def set(self, case, data, context):
case.headers = case.headers or {}
case.headers = {"Authorization": f"Bearer {data}"}
Third-party implementation
--------------------------
If you'd like to use an authentication mechanism that is not natively supported by Schemathesis, you can use third-party extensions to the ``requests`` library inside Schemathesis tests.
You can pass a ``requests.auth.AuthBase`` subclass instance to ``auth.set_from_requests`` and Schemathesis will use it automatically for every request it makes during testing.
.. important::
Note, that this feature works only over HTTP and Python's WSGI transport is not supported.
Here is an example that uses the `requests-ntlm <https://github.com/requests/requests-ntlm>`_ library that supports the `NTLM HTTP Authentication <https://datatracker.ietf.org/doc/html/rfc4559>`_ protocol.
.. code:: python
import schemathesis
from requests_ntlm import HttpNtlmAuth
schemathesis.auth.set_from_requests(HttpNtlmAuth("domain\\username", "password"))
.. note::
You'll need to load this code as any other hook for CLI.
For Python tests it works similarly:
.. code-block:: python
import schemathesis
from requests_ntlm import HttpNtlmAuth
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
schema.auth.set_from_requests(HttpNtlmAuth("domain\\username", "password"))
@schema.parametrize()
def test_api(case):
...
Custom test client in Python tests
----------------------------------
Sometimes you need to reuse the same test client across multiple tests to share authentication data or execute custom events during session startup or shutdown (such as establishing a database connection):
.. code-block:: python
from myapp import app
from starlette_testclient import TestClient
schema = schemathesis.from_asgi("/openapi.json", app=app)
@schema.parametrize()
def test_api(case):
with TestClient(app) as session:
case.call_and_validate(session=session)
|
schemathesis
|
/schemathesis-3.19.2.tar.gz/schemathesis-3.19.2/docs/auth.rst
|
auth.rst
|
Authentication
==============
In this section, we'll cover how to use Schemathesis to test APIs that require authentication.
We'll start with the basics of setting authentication credentials manually using headers, cookies, and query strings.
Then, we'll move on to more advanced topics, including HTTP Basic, Digest Authentication, custom authentication mechanisms, and reusing sessions in Python tests.
Setting credentials
-------------------
To set authentication credentials manually, you can pass a key-value pairs to Schemathesis when running tests.
Here's an example command for setting a custom header or cookie using the CLI:
.. code:: text
st run -H "Authorization: Bearer TOKEN" ...
st run -H "Cookie: session=SECRET" ...
You can also provide multiple headers by using the ``-H`` option multiple times:
.. code:: text
st run -H "Authorization: Bearer TOKEN" -H "X-Session-Id: SECRET" ...
.. note::
Query string authentication is not yet supported in the Schemathesis CLI, however, you can use custom authentication mechanisms to set authentication in a query string parameter.
Details on how to do this are described in the :ref:`Custom Authentication <custom-auth>` section below.
For Python tests you can set a header, cookie or a query parameter inside your test function:
.. code-block:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.parametrize()
def test_api(case):
# Header
case.call_and_validate(headers={"Authorization": "Bearer TOKEN"})
# Cookie
case.call_and_validate(cookies={"session": "SECRET"})
# Query parameter
case.call_and_validate(params={"Api-Key": "KEY"})
Built-In Authentication mechanisms
----------------------------------
`HTTP Basic <https://datatracker.ietf.org/doc/html/rfc7617>`_ and `HTTP Digest <https://datatracker.ietf.org/doc/html/rfc7616>`_ are two common authentication schemes supported by Schemathesis out of the box.
.. code:: text
st run --auth user:pass --auth-type=basic ...
st run --auth user:pass --auth-type=digest ...
In Python tests, you can use the `requests <https://github.com/psf/requests>`_ library to send requests with HTTP Basic or HTTP Digest authentication.
You can pass the authentication credentials using the ``auth`` arguments of the ``call`` or ``call_and_validate`` methods:
.. code-block:: python
import schemathesis
from requests.auth import HTTPDigestAuth
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.parametrize()
def test_api(case):
# HTTP Basic
case.call_and_validate(auth=("user", "password"))
# HTTP Digest
case.call_and_validate(auth=HTTPDigestAuth("user", "password"))
.. _custom-auth:
Custom Authentication
---------------------
In addition to the built-in authentication options, Schemathesis also allows you to implement your own custom authentication mechanisms in Python.
It can be useful if you are working with an API that uses a custom authentication method.
This section will explain how to define custom authentication mechanisms and use them in CLI and Python tests.
Implementation
~~~~~~~~~~~~~~
To implement a custom authentication mechanism, you need to create a Python class with two methods and plug it into Schemathesis.
The two methods your class should contain are:
- ``get``: This method should get the authentication data and return it.
- ``set``: This method should modify the generated test sample so that it contains the authentication data.
Here's an example of a simple custom authentication class. However, please note that this code alone will not work without the necessary registration steps, which will be described later in this section.
.. code:: python
import requests
# This is a real endpoint, try it out!
TOKEN_ENDPOINT = "https://example.schemathesis.io/api/token/"
USERNAME = "demo"
PASSWORD = "test"
class MyAuth:
def get(self, context):
response = requests.post(
TOKEN_ENDPOINT,
json={"username": USERNAME, "password": PASSWORD},
)
data = response.json()
return data["access_token"]
def set(self, case, data, context):
case.headers = case.headers or {}
case.headers["Authorization"] = f"Bearer {data}"
The ``get`` method sends a request to a token endpoint and returns the access token retrieved from the JSON response.
The ``set`` method modifies the generated ``Case`` instance so that it contains the authentication data, adding an ``Authorization`` header with the retrieved token.
The ``context`` argument contains a few attributes useful for the authentication process:
- ``context.operation``. API operation that is currently being tested
- ``context.app``. A Python application if the WSGI / ASGI integration is used
Using in CLI
~~~~~~~~~~~~
To use your custom authentication mechanism in the Schemathesis CLI, you need to register it globally. Here's an example of how to do that:
.. code:: python
import schemathesis
@schemathesis.auth()
class MyAuth:
# Here goes your implementation
...
Put the code above to the ``hooks.py`` file and extend your command via the ``SCHEMATHESIS_HOOKS`` environment variable:
.. code:: bash
$ SCHEMATHESIS_HOOKS=hooks
$ st run ...
.. note::
You can take a look at how to extend CLI :ref:`here <extend-cli>`
Using in Python tests
~~~~~~~~~~~~~~~~~~~~~
To use your custom authentication mechanism in Python tests, you also need to register it.
The registration process is similar to the global registration for CLI, but instead, you can register your auth implementation at the schema or test level.
The following example shows how to use auth only tests generated via the ``schema`` instance:
.. code:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.auth()
class MyAuth:
# Here goes your implementation
...
And this one shows auth applied only to the ``test_api`` function:
.. code:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
class MyAuth:
# Here goes your implementation
...
@schema.auth(MyAuth)
@schema.parametrize()
def test_api(case):
...
Conditional Authentication
~~~~~~~~~~~~~~~~~~~~~~~~~~
Schemathesis offers a way to apply authentication to only a specific set of API operations during testing.
This is helpful when you need to test different authentication types for different API operations or when the API has a combination of authenticated and unauthenticated endpoints.
Multiple filters can be combined and applied to include or exclude API operations based on exact values, regular expressions, or custom functions.
Here is how you can apply auth to all API operations with the ``/users/`` path, but exclude the ``POST`` method.
.. code:: python
import schemathesis
@schemathesis.auth().apply_to(path="/users/").skip_for(method="POST")
class MyAuth:
# Here goes your implementation
...
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
@schema.auth(MyAuth).apply_to(path="/users/").skip_for(method="POST")
@schema.parametrize()
def test_api(case):
...
.. note::
This decorator syntax is supported only on Python 3.9+. For older Python versions you need to bind separate variables for each term.
Basic rules:
- ``apply_to`` applies authentication to all API operations that match the filter term
- ``skip_for`` skips authentication for all API operations that match the filter term
- All conditions within a filter term are combined with the ``AND`` logic
- Each ``apply_to`` and ``skip_for`` term is combined with the ``OR`` logic
- Both ``apply_to`` and ``skip_for`` use the same set of conditions as arguments
Conditions:
- ``path``: the path of the API operation without its ``basePath``.
- ``method``: the upper-cased HTTP method of the API operation
- ``name``: the name of the API operation, such as ``GET /users/`` or ``Query.getUsers``
- Each condition can take either a single string or a list of options as input
- You can also use a regular expression to match the conditions by adding ``_regex`` to the end of the condition and passing a string or a compiled regex.
Here are some examples for ``path``, other conditions works the same:
.. code:: python
import re
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
# Only `/users/`
@schema.auth().apply_to(path="/users/")
# Only `/users/` and `/orders/`
@schema.auth().apply_to(path=["/users/", "/orders/"])
# Only paths starting with `/u`
@schema.auth().apply_to(path_regex="^/u")
# Only paths starting with `/u` case insensitive
@schema.auth().apply_to(path_regex=re.compile("^/u", re.IGNORECASE))
# Only `GET /users/` or `POST /orders/`
@schema.auth().apply_to(
method="GET",
path="/users/",
).apply_to(
method="POST",
path="/orders/",
)
class MyAuth:
# Here goes your implementation
...
You can also use a custom function to determine whether to apply or skip authentication for a given operation.
The function should take an ``AuthContext`` instance and return a boolean value.
To use a custom function with ``apply_to`` or ``skip_for``, simply pass it as the first argument. For example:
.. code:: python
import schemathesis
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
def is_deprecated(ctx):
return ctx.operation.definition.get("deprecated") is True
# Skip auth for all deprecated API operations
@schema.auth().skip_for(is_deprecated)
class MyAuth:
# Here goes your implementation
...
Refreshing credentials
~~~~~~~~~~~~~~~~~~~~~~
By default, the authentication data from the ``get`` method is cached for a while (300 seconds by default).
To customize the caching behavior, pass the ``refresh_interval`` argument to the ``auth`` / ``register`` / ``apply`` functions.
This parameter specifies the number of seconds for which the authentication data will be cached after a non-cached ``get`` call.
To disable caching completely, set ``refresh_interval`` to None. For example, the following code sets the caching time to 600 seconds:
.. code:: python
import schemathesis
@schemathesis.auth(refresh_interval=600)
class MyAuth:
# Here goes your implementation
...
WSGI / ASGI support
~~~~~~~~~~~~~~~~~~~
If you are testing a Python app, you might want to use the WSGI / ASGI integrations and get authentication data from your application instance directly.
It could be done by using the ``context`` to get the application instance:
**FastAPI**:
.. code:: python
from myapp import app
from starlette_testclient import TestClient
schema = schemathesis.from_asgi("/openapi.json", app=app)
TOKEN_ENDPOINT = "/auth/token/"
USERNAME = "demo"
PASSWORD = "test"
@schema.auth()
class MyAuth:
def get(self, context):
client = TestClient(context.app)
response = client.post(
TOKEN_ENDPOINT, json={"username": USERNAME, "password": PASSWORD}
)
return response.json()["access_token"]
def set(self, case, data, context):
case.headers = case.headers or {}
case.headers["Authorization"] = f"Bearer {data}"
**Flask**:
.. code:: python
from myapp import app
import werkzeug
schema = schemathesis.from_wsgi("/openapi.json", app=app)
TOKEN_ENDPOINT = "/auth/token/"
USERNAME = "demo"
PASSWORD = "test"
@schema.auth()
class MyAuth:
def get(self, context):
client = werkzeug.Client(context.app)
response = client.post(
TOKEN_ENDPOINT, json={"username": USERNAME, "password": PASSWORD}
)
return response.json["access_token"]
def set(self, case, data, context):
case.headers = case.headers or {}
case.headers["Authorization"] = f"Bearer {data}"
Refresh tokens
~~~~~~~~~~~~~~
As auth provider class can hold additional state, you can use it to implement more complex authentication flows.
For example, you can use refresh tokens for authentication.
.. code:: python
import requests
import schemathesis
TOKEN_ENDPOINT = "https://auth.myapp.com/api/token/"
REFRESH_ENDPOINT = "https://auth.myapp.com/api/refresh/"
USERNAME = "demo"
PASSWORD = "test"
@schemathesis.auth()
class MyAuth:
def __init__(self):
self.refresh_token = None
def get(self, context):
if self.refresh_token is not None:
return self.refresh(context)
return self.login(context)
def login(self, context):
response = requests.post(
TOKEN_ENDPOINT,
json={"username": USERNAME, "password": PASSWORD},
)
data = response.json()
self.refresh_token = data["refresh_token"]
return data["access_token"]
def refresh(self, context):
response = requests.post(
REFRESH_ENDPOINT,
headers={"Authorization": f"Bearer {self.refresh_token}"},
)
data = response.json()
self.refresh_token = data["refresh_token"]
return data["access_token"]
def set(self, case, data, context):
case.headers = case.headers or {}
case.headers = {"Authorization": f"Bearer {data}"}
Third-party implementation
--------------------------
If you'd like to use an authentication mechanism that is not natively supported by Schemathesis, you can use third-party extensions to the ``requests`` library inside Schemathesis tests.
You can pass a ``requests.auth.AuthBase`` subclass instance to ``auth.set_from_requests`` and Schemathesis will use it automatically for every request it makes during testing.
.. important::
Note, that this feature works only over HTTP and Python's WSGI transport is not supported.
Here is an example that uses the `requests-ntlm <https://github.com/requests/requests-ntlm>`_ library that supports the `NTLM HTTP Authentication <https://datatracker.ietf.org/doc/html/rfc4559>`_ protocol.
.. code:: python
import schemathesis
from requests_ntlm import HttpNtlmAuth
schemathesis.auth.set_from_requests(HttpNtlmAuth("domain\\username", "password"))
.. note::
You'll need to load this code as any other hook for CLI.
For Python tests it works similarly:
.. code-block:: python
import schemathesis
from requests_ntlm import HttpNtlmAuth
schema = schemathesis.from_uri("https://example.schemathesis.io/openapi.json")
schema.auth.set_from_requests(HttpNtlmAuth("domain\\username", "password"))
@schema.parametrize()
def test_api(case):
...
Custom test client in Python tests
----------------------------------
Sometimes you need to reuse the same test client across multiple tests to share authentication data or execute custom events during session startup or shutdown (such as establishing a database connection):
.. code-block:: python
from myapp import app
from starlette_testclient import TestClient
schema = schemathesis.from_asgi("/openapi.json", app=app)
@schema.parametrize()
def test_api(case):
with TestClient(app) as session:
case.call_and_validate(session=session)
| 0.90851 | 0.69766 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.