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 WearableSizeSystemJP(BaseModel):
"""Japanese size system for wearables.
References:
https://schema.org/WearableSizeSystemJP
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="WearableSizeSystemJP", 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/WearableSizeSystemJP.py
|
WearableSizeSystemJP.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableSizeSystemJP(BaseModel):
"""Japanese size system for wearables.
References:
https://schema.org/WearableSizeSystemJP
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="WearableSizeSystemJP", 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.940579 | 0.313932 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ShippingDeliveryTime(BaseModel):
"""ShippingDeliveryTime provides various pieces of information about delivery times for shipping.
References:
https://schema.org/ShippingDeliveryTime
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.
cutoffTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): Order cutoff time allows merchants to describe the time after which they will no longer process orders received on that day. For orders processed after cutoff time, one day gets added to the delivery time estimate. This property is expected to be most typically used via the [[ShippingRateSettings]] publication pattern. The time is indicated using the ISO-8601 Time format, e.g. "23:30:00-05:00" would represent 6:30 pm Eastern Standard Time (EST) which is 5 hours behind Coordinated Universal Time (UTC).
transitTime: (Optional[Union[List[Union[str, Any]], str, Any]]): The typical delay the order has been sent for delivery and the goods reach the final customer. Typical properties: minValue, maxValue, unitCode (d for DAY).
handlingTime: (Optional[Union[List[Union[str, Any]], str, Any]]): The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup. Typical properties: minValue, maxValue, unitCode (d for DAY). This is by common convention assumed to mean business days (if a unitCode is used, coded as "d"), i.e. only counting days when the business normally operates.
businessDays: (Optional[Union[List[Union[str, Any]], str, Any]]): Days of the week when the merchant typically operates, indicated via opening hours markup.
"""
type_: str = Field(default="ShippingDeliveryTime", 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.",
)
cutoffTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="Order cutoff time allows merchants to describe the time after which they will no longer"
"process orders received on that day. For orders processed after cutoff time, one day"
"gets added to the delivery time estimate. This property is expected to be most typically"
"used via the [[ShippingRateSettings]] publication pattern. The time is indicated"
'using the ISO-8601 Time format, e.g. "23:30:00-05:00" would represent 6:30 pm Eastern'
"Standard Time (EST) which is 5 hours behind Coordinated Universal Time (UTC).",
)
transitTime: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The typical delay the order has been sent for delivery and the goods reach the final customer."
"Typical properties: minValue, maxValue, unitCode (d for DAY).",
)
handlingTime: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The typical delay between the receipt of the order and the goods either leaving the warehouse"
"or being prepared for pickup, in case the delivery method is on site pickup. Typical properties:"
"minValue, maxValue, unitCode (d for DAY). This is by common convention assumed to mean"
'business days (if a unitCode is used, coded as "d"), i.e. only counting days when the'
"business normally operates.",
)
businessDays: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Days of the week when the merchant typically operates, indicated via opening hours markup.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/ShippingDeliveryTime.py
|
ShippingDeliveryTime.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ShippingDeliveryTime(BaseModel):
"""ShippingDeliveryTime provides various pieces of information about delivery times for shipping.
References:
https://schema.org/ShippingDeliveryTime
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.
cutoffTime: (Optional[Union[List[Union[datetime, str, Any]], datetime, str, Any]]): Order cutoff time allows merchants to describe the time after which they will no longer process orders received on that day. For orders processed after cutoff time, one day gets added to the delivery time estimate. This property is expected to be most typically used via the [[ShippingRateSettings]] publication pattern. The time is indicated using the ISO-8601 Time format, e.g. "23:30:00-05:00" would represent 6:30 pm Eastern Standard Time (EST) which is 5 hours behind Coordinated Universal Time (UTC).
transitTime: (Optional[Union[List[Union[str, Any]], str, Any]]): The typical delay the order has been sent for delivery and the goods reach the final customer. Typical properties: minValue, maxValue, unitCode (d for DAY).
handlingTime: (Optional[Union[List[Union[str, Any]], str, Any]]): The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup. Typical properties: minValue, maxValue, unitCode (d for DAY). This is by common convention assumed to mean business days (if a unitCode is used, coded as "d"), i.e. only counting days when the business normally operates.
businessDays: (Optional[Union[List[Union[str, Any]], str, Any]]): Days of the week when the merchant typically operates, indicated via opening hours markup.
"""
type_: str = Field(default="ShippingDeliveryTime", 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.",
)
cutoffTime: Optional[
Union[List[Union[datetime, str, Any]], datetime, str, Any]
] = Field(
default=None,
description="Order cutoff time allows merchants to describe the time after which they will no longer"
"process orders received on that day. For orders processed after cutoff time, one day"
"gets added to the delivery time estimate. This property is expected to be most typically"
"used via the [[ShippingRateSettings]] publication pattern. The time is indicated"
'using the ISO-8601 Time format, e.g. "23:30:00-05:00" would represent 6:30 pm Eastern'
"Standard Time (EST) which is 5 hours behind Coordinated Universal Time (UTC).",
)
transitTime: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The typical delay the order has been sent for delivery and the goods reach the final customer."
"Typical properties: minValue, maxValue, unitCode (d for DAY).",
)
handlingTime: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The typical delay between the receipt of the order and the goods either leaving the warehouse"
"or being prepared for pickup, in case the delivery method is on site pickup. Typical properties:"
"minValue, maxValue, unitCode (d for DAY). This is by common convention assumed to mean"
'business days (if a unitCode is used, coded as "d"), i.e. only counting days when the'
"business normally operates.",
)
businessDays: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Days of the week when the merchant typically operates, indicated via opening hours markup.",
)
| 0.937733 | 0.376251 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Retail(BaseModel):
"""The drug's cost represents the retail cost of the drug.
References:
https://schema.org/Retail
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="Retail", 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/Retail.py
|
Retail.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Retail(BaseModel):
"""The drug's cost represents the retail cost of the drug.
References:
https://schema.org/Retail
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="Retail", 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.943867 | 0.350783 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BuyAction(BaseModel):
"""The act of giving money to a seller in exchange for goods or services rendered. An agent buys an object, product, or service from a seller for a price. Reciprocal of SellAction.
References:
https://schema.org/BuyAction
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*.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
priceSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more detailed price specifications, indicating the unit price and delivery or payment charges.
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
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.
warrantyPromise: (Optional[Union[List[Union[str, Any]], str, Any]]): The warranty promise(s) included in the offer.
vendor: (Optional[Union[List[Union[str, Any]], str, Any]]): 'vendor' is an earlier term for 'seller'.
"""
type_: str = Field(default="BuyAction", 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*.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
priceSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more detailed price specifications, indicating the unit price and delivery or"
"payment charges.",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
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.",
)
warrantyPromise: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The warranty promise(s) included in the offer.",
)
vendor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="'vendor' is an earlier term for 'seller'.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/BuyAction.py
|
BuyAction.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BuyAction(BaseModel):
"""The act of giving money to a seller in exchange for goods or services rendered. An agent buys an object, product, or service from a seller for a price. Reciprocal of SellAction.
References:
https://schema.org/BuyAction
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*.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
priceSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more detailed price specifications, indicating the unit price and delivery or payment charges.
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
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.
warrantyPromise: (Optional[Union[List[Union[str, Any]], str, Any]]): The warranty promise(s) included in the offer.
vendor: (Optional[Union[List[Union[str, Any]], str, Any]]): 'vendor' is an earlier term for 'seller'.
"""
type_: str = Field(default="BuyAction", 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*.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
priceSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more detailed price specifications, indicating the unit price and delivery or"
"payment charges.",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
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.",
)
warrantyPromise: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The warranty promise(s) included in the offer.",
)
vendor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="'vendor' is an earlier term for 'seller'.",
)
| 0.940449 | 0.450299 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CompilationAlbum(BaseModel):
"""CompilationAlbum.
References:
https://schema.org/CompilationAlbum
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="CompilationAlbum", 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/CompilationAlbum.py
|
CompilationAlbum.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CompilationAlbum(BaseModel):
"""CompilationAlbum.
References:
https://schema.org/CompilationAlbum
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="CompilationAlbum", 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.939484 | 0.305982 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DDxElement(BaseModel):
"""An alternative, closely-related condition typically considered later in the differential diagnosis process along with the signs that are used to distinguish it.
References:
https://schema.org/DDxElement
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.
distinguishingSign: (Optional[Union[List[Union[str, Any]], str, Any]]): One of a set of signs and symptoms that can be used to distinguish this diagnosis from others in the differential diagnosis.
diagnosis: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more alternative conditions considered in the differential diagnosis process as output of a diagnosis process.
"""
type_: str = Field(default="DDxElement", 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.",
)
distinguishingSign: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One of a set of signs and symptoms that can be used to distinguish this diagnosis from others"
"in the differential diagnosis.",
)
diagnosis: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more alternative conditions considered in the differential diagnosis process"
"as output of a diagnosis process.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/DDxElement.py
|
DDxElement.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DDxElement(BaseModel):
"""An alternative, closely-related condition typically considered later in the differential diagnosis process along with the signs that are used to distinguish it.
References:
https://schema.org/DDxElement
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.
distinguishingSign: (Optional[Union[List[Union[str, Any]], str, Any]]): One of a set of signs and symptoms that can be used to distinguish this diagnosis from others in the differential diagnosis.
diagnosis: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more alternative conditions considered in the differential diagnosis process as output of a diagnosis process.
"""
type_: str = Field(default="DDxElement", 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.",
)
distinguishingSign: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One of a set of signs and symptoms that can be used to distinguish this diagnosis from others"
"in the differential diagnosis.",
)
diagnosis: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more alternative conditions considered in the differential diagnosis process"
"as output of a diagnosis process.",
)
| 0.932168 | 0.363421 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class NonprofitANBI(BaseModel):
"""NonprofitANBI: Non-profit type referring to a Public Benefit Organization (NL).
References:
https://schema.org/NonprofitANBI
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="NonprofitANBI", 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/NonprofitANBI.py
|
NonprofitANBI.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class NonprofitANBI(BaseModel):
"""NonprofitANBI: Non-profit type referring to a Public Benefit Organization (NL).
References:
https://schema.org/NonprofitANBI
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="NonprofitANBI", 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.947998 | 0.281835 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OrderItem(BaseModel):
"""An order item is a line of an order. It includes the quantity and shipping details of a bought offer.
References:
https://schema.org/OrderItem
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.
orderItemStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): The current status of the order item.
orderQuantity: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The number of the item ordered. If the property is not set, assume the quantity is one.
orderDelivery: (Optional[Union[List[Union[str, Any]], str, Any]]): The delivery of the parcel related to this order or order item.
orderedItem: (Optional[Union[List[Union[str, Any]], str, Any]]): The item ordered.
orderItemNumber: (Union[List[Union[str, Any]], str, Any]): The identifier of the order item.
"""
type_: str = Field(default="OrderItem", 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.",
)
orderItemStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The current status of the order item.",
)
orderQuantity: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The number of the item ordered. If the property is not set, assume the quantity is one.",
)
orderDelivery: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The delivery of the parcel related to this order or order item.",
)
orderedItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The item ordered.",
)
orderItemNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The identifier of the order item.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/OrderItem.py
|
OrderItem.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OrderItem(BaseModel):
"""An order item is a line of an order. It includes the quantity and shipping details of a bought offer.
References:
https://schema.org/OrderItem
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.
orderItemStatus: (Optional[Union[List[Union[str, Any]], str, Any]]): The current status of the order item.
orderQuantity: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The number of the item ordered. If the property is not set, assume the quantity is one.
orderDelivery: (Optional[Union[List[Union[str, Any]], str, Any]]): The delivery of the parcel related to this order or order item.
orderedItem: (Optional[Union[List[Union[str, Any]], str, Any]]): The item ordered.
orderItemNumber: (Union[List[Union[str, Any]], str, Any]): The identifier of the order item.
"""
type_: str = Field(default="OrderItem", 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.",
)
orderItemStatus: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The current status of the order item.",
)
orderQuantity: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The number of the item ordered. If the property is not set, assume the quantity is one.",
)
orderDelivery: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The delivery of the parcel related to this order or order item.",
)
orderedItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The item ordered.",
)
orderItemNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The identifier of the order item.",
)
| 0.943158 | 0.377254 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Podiatric(BaseModel):
"""Podiatry is the care of the human foot, especially the diagnosis and treatment of foot disorders.
References:
https://schema.org/Podiatric
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.
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.
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="Podiatric", 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.",
)
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/Podiatric.py
|
Podiatric.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Podiatric(BaseModel):
"""Podiatry is the care of the human foot, especially the diagnosis and treatment of foot disorders.
References:
https://schema.org/Podiatric
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.
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.
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="Podiatric", 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.",
)
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.906694 | 0.348617 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalSpecialty(BaseModel):
"""Any specific branch of medical science or practice. Medical specialities include clinical specialties that pertain to particular organ systems and their respective disease states, as well as allied health specialties. Enumerated type.
References:
https://schema.org/MedicalSpecialty
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.
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="MedicalSpecialty", 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/MedicalSpecialty.py
|
MedicalSpecialty.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalSpecialty(BaseModel):
"""Any specific branch of medical science or practice. Medical specialities include clinical specialties that pertain to particular organ systems and their respective disease states, as well as allied health specialties. Enumerated type.
References:
https://schema.org/MedicalSpecialty
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.
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="MedicalSpecialty", 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.933249 | 0.361108 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MSRP(BaseModel):
"""Represents the manufacturer suggested retail price ("MSRP") of an offered product.
References:
https://schema.org/MSRP
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="MSRP", 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/MSRP.py
|
MSRP.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MSRP(BaseModel):
"""Represents the manufacturer suggested retail price ("MSRP") of an offered product.
References:
https://schema.org/MSRP
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="MSRP", 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.945261 | 0.330958 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableSizeGroupTall(BaseModel):
"""Size group "Tall" for wearables.
References:
https://schema.org/WearableSizeGroupTall
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="WearableSizeGroupTall", 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/WearableSizeGroupTall.py
|
WearableSizeGroupTall.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableSizeGroupTall(BaseModel):
"""Size group "Tall" for wearables.
References:
https://schema.org/WearableSizeGroupTall
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="WearableSizeGroupTall", 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.941888 | 0.289381 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ReadPermission(BaseModel):
"""Permission to read or view the document.
References:
https://schema.org/ReadPermission
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="ReadPermission", 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/ReadPermission.py
|
ReadPermission.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ReadPermission(BaseModel):
"""Permission to read or view the document.
References:
https://schema.org/ReadPermission
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="ReadPermission", 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.942922 | 0.305399 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CharitableIncorporatedOrganization(BaseModel):
"""CharitableIncorporatedOrganization: Non-profit type referring to a Charitable Incorporated Organization (UK).
References:
https://schema.org/CharitableIncorporatedOrganization
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="CharitableIncorporatedOrganization", 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/CharitableIncorporatedOrganization.py
|
CharitableIncorporatedOrganization.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CharitableIncorporatedOrganization(BaseModel):
"""CharitableIncorporatedOrganization: Non-profit type referring to a Charitable Incorporated Organization (UK).
References:
https://schema.org/CharitableIncorporatedOrganization
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="CharitableIncorporatedOrganization", 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.944677 | 0.302835 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ChooseAction(BaseModel):
"""The act of expressing a preference from a set of options or a large or unbounded set of choices/options.
References:
https://schema.org/ChooseAction
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*.
option: (Union[List[Union[str, Any]], str, Any]): A sub property of object. The options subject to this action.
actionOption: (Union[List[Union[str, Any]], str, Any]): A sub property of object. The options subject to this action.
"""
type_: str = Field(default="ChooseAction", 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*.",
)
option: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of object. The options subject to this action.",
)
actionOption: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of object. The options subject to this action.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/ChooseAction.py
|
ChooseAction.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ChooseAction(BaseModel):
"""The act of expressing a preference from a set of options or a large or unbounded set of choices/options.
References:
https://schema.org/ChooseAction
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*.
option: (Union[List[Union[str, Any]], str, Any]): A sub property of object. The options subject to this action.
actionOption: (Union[List[Union[str, Any]], str, Any]): A sub property of object. The options subject to this action.
"""
type_: str = Field(default="ChooseAction", 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*.",
)
option: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of object. The options subject to this action.",
)
actionOption: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A sub property of object. The options subject to this action.",
)
| 0.940166 | 0.418043 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ProductGroup(BaseModel):
"""A ProductGroup represents a group of [[Product]]s that vary only in certain well-described ways, such as by [[size]], [[color]], [[material]] etc.While a ProductGroup itself is not directly offered for sale, the various varying products that it represents can be. The ProductGroup serves as a prototype or template, standing in for all of the products who have an [[isVariantOf]] relationship to it. As such, properties (including additional types) can be applied to the ProductGroup to represent characteristics shared by each of the (possibly very many) variants. Properties that reference a ProductGroup are not included in this mechanism; neither are the following specific properties [[variesBy]], [[hasVariant]], [[url]].
References:
https://schema.org/ProductGroup
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.
hasMeasurement: (Optional[Union[List[Union[str, Any]], str, Any]]): A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.
countryOfAssembly: (Union[List[Union[str, Any]], str, Any]): The place where the product was assembled.
width: (Optional[Union[List[Union[str, Any]], str, Any]]): The width of the item.
isAccessoryOrSparePartFor: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another product (or multiple products) for which this product is an accessory or spare part.
isConsumableFor: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another product (or multiple products) for which this product is a consumable.
depth: (Optional[Union[List[Union[str, Any]], str, Any]]): The depth of the item.
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.
isVariantOf: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
manufacturer: (Optional[Union[List[Union[str, Any]], str, Any]]): The manufacturer of the product.
gtin14: (Union[List[Union[str, Any]], str, Any]): The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
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.
positiveNotes: (Union[List[Union[str, Any]], str, Any]): Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described.The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
height: (Optional[Union[List[Union[str, Any]], str, Any]]): The height of the item.
model: (Union[List[Union[str, Any]], str, Any]): The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.
itemCondition: (Optional[Union[List[Union[str, Any]], str, Any]]): A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
nsn: (Union[List[Union[str, Any]], str, Any]): Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [[Product]].
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.
gtin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809) for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.
isRelatedTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, somehow related product (or multiple products).
negativeNotes: (Union[List[Union[str, Any]], str, Any]): Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]].The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).
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]].
mobileUrl: (Union[List[Union[str, Any]], str, Any]): The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.
hasEnergyConsumptionDetails: (Optional[Union[List[Union[str, Any]], str, Any]]): Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.
weight: (Optional[Union[List[Union[str, Any]], str, Any]]): The weight of the product or person.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
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.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
gtin12: (Union[List[Union[str, Any]], str, Any]): The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
isSimilarTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, functionally similar product (or multiple products).
productID: (Union[List[Union[str, Any]], str, Any]): The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```.
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.
hasAdultConsideration: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to tag an item to be intended or suitable for consumption or use by adults only.
purchaseDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date the item, e.g. vehicle, was purchased by the current owner.
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.
countryOfLastProcessing: (Union[List[Union[str, Any]], str, Any]): The place where the item (typically [[Product]]) was last processed and tested before importation.
asin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s article).Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details.ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.
gtin8: (Union[List[Union[str, Any]], str, Any]): The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
releaseDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The release date of a product or product model. This can be used to distinguish the exact variant of a product.
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.
productionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date of production of the item, e.g. vehicle.
inProductGroupWithID: (Union[List[Union[str, Any]], str, Any]): Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].
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.
mpn: (Union[List[Union[str, Any]], str, Any]): The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
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.
color: (Union[List[Union[str, Any]], str, Any]): The color of the product.
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
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.
gtin13: (Union[List[Union[str, Any]], str, Any]): The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
sku: (Union[List[Union[str, Any]], str, Any]): The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
variesBy: (Union[List[Union[str, Any]], str, Any]): Indicates the property or properties by which the variants in a [[ProductGroup]] vary, e.g. their size, color etc. Schema.org properties can be referenced by their short name e.g. "color"; terms defined elsewhere can be referenced with their URIs.
hasVariant: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a [[Product]] that is a member of this [[ProductGroup]] (or [[ProductModel]]).
productGroupID: (Union[List[Union[str, Any]], str, Any]): Indicates a textual identifier for a ProductGroup.
"""
type_: str = Field(default="ProductGroup", 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.",
)
hasMeasurement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A product measurement, for example the inseam of pants, the wheel size of a bicycle, or"
"the gauge of a screw. Usually an exact measurement, but can also be a range of measurements"
"for adjustable products, for example belts and ski bindings.",
)
countryOfAssembly: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The place where the product was assembled.",
)
width: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The width of the item.",
)
isAccessoryOrSparePartFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another product (or multiple products) for which this product is an accessory"
"or spare part.",
)
isConsumableFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another product (or multiple products) for which this product is a consumable.",
)
depth: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The depth of the item.",
)
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.",
)
isVariantOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the kind of product that this is a variant of. In the case of [[ProductModel]],"
"this is a pointer (from a ProductModel) to a base product from which this product is a variant."
"It is safe to infer that the variant inherits all product features from the base model,"
"unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the"
"group description also serves as a template, representing a set of Products that vary"
"on explicitly defined, specific dimensions only (so it defines both a set of variants,"
"as well as which values distinguish amongst those variants). When used with [[ProductGroup]],"
"this property can apply to any [[Product]] included in the group.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
manufacturer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The manufacturer of the product.",
)
gtin14: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN"
"Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.",
)
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.",
)
positiveNotes: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Provides positive considerations regarding something, for example product highlights"
"or (alongside [[negativeNotes]]) pro/con lists for reviews.In the case of a [[Review]],"
"the property describes the [[itemReviewed]] from the perspective of the review; in"
"the case of a [[Product]], the product itself is being described.The property values"
"can be expressed either as unstructured text (repeated as necessary), or if ordered,"
"as a list (in which case the most positive is at the beginning of the list).",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
height: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The height of the item.",
)
model: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The model of the product. Use with the URL of a ProductModel or a textual representation"
"of the model identifier. The URL of the ProductModel can be from an external source. It"
"is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14"
"and mpn properties.",
)
itemCondition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A predefined value from OfferItemCondition specifying the condition of the product"
"or service, or the products or services included in the offer. Also used for product return"
"policies to specify the condition of products accepted for returns.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
nsn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number)"
"(nsn) of a [[Product]].",
)
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.",
)
gtin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin))."
"GTINs identify trade items, including products and services, using numeric identification"
"codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/)"
"express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples"
"can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking"
"issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809)"
"for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN,"
"which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or"
'a "GS1 Digital Link" URL based on such a string. The numeric component should also have'
"a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator)"
"and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for"
"more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]]"
"property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]]"
"properties.Note also that this is a definition for how to include GTINs in Schema.org"
"data, and not a definition of GTINs in general - see the GS1 documentation for authoritative"
"details.",
)
isRelatedTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, somehow related product (or multiple products).",
)
negativeNotes: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Provides negative considerations regarding something, most typically in pro/con"
"lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]],"
"the property describes the [[itemReviewed]] from the perspective of the review; in"
"the case of a [[Product]], the product itself is being described. Since product descriptions"
"tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]]"
"used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used"
"on [[Product]].The property values can be expressed either as unstructured text (repeated"
"as necessary), or if ordered, as a list (in which case the most negative is at the beginning"
"of the list).",
)
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]].",
)
mobileUrl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [[mobileUrl]] property is provided for specific situations in which data consumers"
"need to determine whether one of several provided URLs is a dedicated 'mobile site'.To"
"discourage over-use, and reflecting intial usecases, the property is expected only"
"on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology"
"is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design)"
"in which content can be flexibly adapted to a wide range of browsing environments. Pages"
"and sites referenced with the long-established [[url]] property should ideally also"
"be usable on a wide variety of devices, including mobile phones. In most cases, it would"
"be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]]"
"for more mobile-oriented pages. The property is intended for the case when items (primarily"
'[[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site"'
"alongside the main one. It should not be taken as an endorsement of this publication style.",
)
hasEnergyConsumptionDetails: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description='Defines the energy efficiency Category (also known as "class" or "rating") for'
"a product according to an international energy efficiency standard.",
)
weight: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The weight of the product or person.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
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.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
gtin12: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12"
"is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference,"
"and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
isSimilarTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, functionally similar product (or multiple products).",
)
productID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='The product identifier, such as ISBN. For example: ``` meta itemprop="productID"'
'content="isbn:123-456-789" ```.',
)
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.",
)
hasAdultConsideration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to tag an item to be intended or suitable for consumption or use by adults only.",
)
purchaseDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date the item, e.g. vehicle, was purchased by the current owner.",
)
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.",
)
countryOfLastProcessing: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The place where the item (typically [[Product]]) was last processed and tested before"
"importation.",
)
asin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique"
"identifier assigned by Amazon.com and its partners for product identification within"
"the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s"
"article).Note also that this is a definition for how to include ASINs in Schema.org data,"
"and not a definition of ASINs in general - see documentation from Amazon for authoritative"
"details.ASINs are most commonly encoded as text strings, but the [asin] property supports"
"URL/URI as potential values too.",
)
gtin8: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-8 code of the product, or the product to which the offer refers. This code is also"
"known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
releaseDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The release date of a product or product model. This can be used to distinguish the exact"
"variant of a product.",
)
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.",
)
productionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date of production of the item, e.g. vehicle.",
)
inProductGroupWithID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].",
)
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.",
)
mpn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.",
)
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.",
)
color: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The color of the product.",
)
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.",
)
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.",
)
gtin13: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent"
"to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into"
"a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
sku: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service,"
"or the product to which the offer refers.",
)
variesBy: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the property or properties by which the variants in a [[ProductGroup]] vary,"
"e.g. their size, color etc. Schema.org properties can be referenced by their short name"
'e.g. "color"; terms defined elsewhere can be referenced with their URIs.',
)
hasVariant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a [[Product]] that is a member of this [[ProductGroup]] (or [[ProductModel]]).",
)
productGroupID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates a textual identifier for a ProductGroup.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/ProductGroup.py
|
ProductGroup.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ProductGroup(BaseModel):
"""A ProductGroup represents a group of [[Product]]s that vary only in certain well-described ways, such as by [[size]], [[color]], [[material]] etc.While a ProductGroup itself is not directly offered for sale, the various varying products that it represents can be. The ProductGroup serves as a prototype or template, standing in for all of the products who have an [[isVariantOf]] relationship to it. As such, properties (including additional types) can be applied to the ProductGroup to represent characteristics shared by each of the (possibly very many) variants. Properties that reference a ProductGroup are not included in this mechanism; neither are the following specific properties [[variesBy]], [[hasVariant]], [[url]].
References:
https://schema.org/ProductGroup
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.
hasMeasurement: (Optional[Union[List[Union[str, Any]], str, Any]]): A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.
countryOfAssembly: (Union[List[Union[str, Any]], str, Any]): The place where the product was assembled.
width: (Optional[Union[List[Union[str, Any]], str, Any]]): The width of the item.
isAccessoryOrSparePartFor: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another product (or multiple products) for which this product is an accessory or spare part.
isConsumableFor: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another product (or multiple products) for which this product is a consumable.
depth: (Optional[Union[List[Union[str, Any]], str, Any]]): The depth of the item.
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.
isVariantOf: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
manufacturer: (Optional[Union[List[Union[str, Any]], str, Any]]): The manufacturer of the product.
gtin14: (Union[List[Union[str, Any]], str, Any]): The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
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.
positiveNotes: (Union[List[Union[str, Any]], str, Any]): Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described.The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
height: (Optional[Union[List[Union[str, Any]], str, Any]]): The height of the item.
model: (Union[List[Union[str, Any]], str, Any]): The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.
itemCondition: (Optional[Union[List[Union[str, Any]], str, Any]]): A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
nsn: (Union[List[Union[str, Any]], str, Any]): Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [[Product]].
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.
gtin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809) for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.
isRelatedTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, somehow related product (or multiple products).
negativeNotes: (Union[List[Union[str, Any]], str, Any]): Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]].The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).
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]].
mobileUrl: (Union[List[Union[str, Any]], str, Any]): The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.
hasEnergyConsumptionDetails: (Optional[Union[List[Union[str, Any]], str, Any]]): Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.
weight: (Optional[Union[List[Union[str, Any]], str, Any]]): The weight of the product or person.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
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.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
gtin12: (Union[List[Union[str, Any]], str, Any]): The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
isSimilarTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, functionally similar product (or multiple products).
productID: (Union[List[Union[str, Any]], str, Any]): The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```.
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.
hasAdultConsideration: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to tag an item to be intended or suitable for consumption or use by adults only.
purchaseDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date the item, e.g. vehicle, was purchased by the current owner.
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.
countryOfLastProcessing: (Union[List[Union[str, Any]], str, Any]): The place where the item (typically [[Product]]) was last processed and tested before importation.
asin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s article).Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details.ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.
gtin8: (Union[List[Union[str, Any]], str, Any]): The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
releaseDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The release date of a product or product model. This can be used to distinguish the exact variant of a product.
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.
productionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date of production of the item, e.g. vehicle.
inProductGroupWithID: (Union[List[Union[str, Any]], str, Any]): Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].
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.
mpn: (Union[List[Union[str, Any]], str, Any]): The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
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.
color: (Union[List[Union[str, Any]], str, Any]): The color of the product.
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
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.
gtin13: (Union[List[Union[str, Any]], str, Any]): The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
sku: (Union[List[Union[str, Any]], str, Any]): The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
variesBy: (Union[List[Union[str, Any]], str, Any]): Indicates the property or properties by which the variants in a [[ProductGroup]] vary, e.g. their size, color etc. Schema.org properties can be referenced by their short name e.g. "color"; terms defined elsewhere can be referenced with their URIs.
hasVariant: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a [[Product]] that is a member of this [[ProductGroup]] (or [[ProductModel]]).
productGroupID: (Union[List[Union[str, Any]], str, Any]): Indicates a textual identifier for a ProductGroup.
"""
type_: str = Field(default="ProductGroup", 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.",
)
hasMeasurement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A product measurement, for example the inseam of pants, the wheel size of a bicycle, or"
"the gauge of a screw. Usually an exact measurement, but can also be a range of measurements"
"for adjustable products, for example belts and ski bindings.",
)
countryOfAssembly: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The place where the product was assembled.",
)
width: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The width of the item.",
)
isAccessoryOrSparePartFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another product (or multiple products) for which this product is an accessory"
"or spare part.",
)
isConsumableFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another product (or multiple products) for which this product is a consumable.",
)
depth: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The depth of the item.",
)
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.",
)
isVariantOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the kind of product that this is a variant of. In the case of [[ProductModel]],"
"this is a pointer (from a ProductModel) to a base product from which this product is a variant."
"It is safe to infer that the variant inherits all product features from the base model,"
"unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the"
"group description also serves as a template, representing a set of Products that vary"
"on explicitly defined, specific dimensions only (so it defines both a set of variants,"
"as well as which values distinguish amongst those variants). When used with [[ProductGroup]],"
"this property can apply to any [[Product]] included in the group.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
manufacturer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The manufacturer of the product.",
)
gtin14: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN"
"Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.",
)
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.",
)
positiveNotes: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Provides positive considerations regarding something, for example product highlights"
"or (alongside [[negativeNotes]]) pro/con lists for reviews.In the case of a [[Review]],"
"the property describes the [[itemReviewed]] from the perspective of the review; in"
"the case of a [[Product]], the product itself is being described.The property values"
"can be expressed either as unstructured text (repeated as necessary), or if ordered,"
"as a list (in which case the most positive is at the beginning of the list).",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
height: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The height of the item.",
)
model: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The model of the product. Use with the URL of a ProductModel or a textual representation"
"of the model identifier. The URL of the ProductModel can be from an external source. It"
"is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14"
"and mpn properties.",
)
itemCondition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A predefined value from OfferItemCondition specifying the condition of the product"
"or service, or the products or services included in the offer. Also used for product return"
"policies to specify the condition of products accepted for returns.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
nsn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number)"
"(nsn) of a [[Product]].",
)
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.",
)
gtin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin))."
"GTINs identify trade items, including products and services, using numeric identification"
"codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/)"
"express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples"
"can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking"
"issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809)"
"for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN,"
"which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or"
'a "GS1 Digital Link" URL based on such a string. The numeric component should also have'
"a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator)"
"and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for"
"more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]]"
"property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]]"
"properties.Note also that this is a definition for how to include GTINs in Schema.org"
"data, and not a definition of GTINs in general - see the GS1 documentation for authoritative"
"details.",
)
isRelatedTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, somehow related product (or multiple products).",
)
negativeNotes: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Provides negative considerations regarding something, most typically in pro/con"
"lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]],"
"the property describes the [[itemReviewed]] from the perspective of the review; in"
"the case of a [[Product]], the product itself is being described. Since product descriptions"
"tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]]"
"used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used"
"on [[Product]].The property values can be expressed either as unstructured text (repeated"
"as necessary), or if ordered, as a list (in which case the most negative is at the beginning"
"of the list).",
)
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]].",
)
mobileUrl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [[mobileUrl]] property is provided for specific situations in which data consumers"
"need to determine whether one of several provided URLs is a dedicated 'mobile site'.To"
"discourage over-use, and reflecting intial usecases, the property is expected only"
"on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology"
"is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design)"
"in which content can be flexibly adapted to a wide range of browsing environments. Pages"
"and sites referenced with the long-established [[url]] property should ideally also"
"be usable on a wide variety of devices, including mobile phones. In most cases, it would"
"be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]]"
"for more mobile-oriented pages. The property is intended for the case when items (primarily"
'[[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site"'
"alongside the main one. It should not be taken as an endorsement of this publication style.",
)
hasEnergyConsumptionDetails: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description='Defines the energy efficiency Category (also known as "class" or "rating") for'
"a product according to an international energy efficiency standard.",
)
weight: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The weight of the product or person.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
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.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
gtin12: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12"
"is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference,"
"and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
isSimilarTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, functionally similar product (or multiple products).",
)
productID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='The product identifier, such as ISBN. For example: ``` meta itemprop="productID"'
'content="isbn:123-456-789" ```.',
)
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.",
)
hasAdultConsideration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to tag an item to be intended or suitable for consumption or use by adults only.",
)
purchaseDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date the item, e.g. vehicle, was purchased by the current owner.",
)
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.",
)
countryOfLastProcessing: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The place where the item (typically [[Product]]) was last processed and tested before"
"importation.",
)
asin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique"
"identifier assigned by Amazon.com and its partners for product identification within"
"the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s"
"article).Note also that this is a definition for how to include ASINs in Schema.org data,"
"and not a definition of ASINs in general - see documentation from Amazon for authoritative"
"details.ASINs are most commonly encoded as text strings, but the [asin] property supports"
"URL/URI as potential values too.",
)
gtin8: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-8 code of the product, or the product to which the offer refers. This code is also"
"known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
releaseDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The release date of a product or product model. This can be used to distinguish the exact"
"variant of a product.",
)
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.",
)
productionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date of production of the item, e.g. vehicle.",
)
inProductGroupWithID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].",
)
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.",
)
mpn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.",
)
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.",
)
color: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The color of the product.",
)
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.",
)
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.",
)
gtin13: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent"
"to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into"
"a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
sku: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service,"
"or the product to which the offer refers.",
)
variesBy: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the property or properties by which the variants in a [[ProductGroup]] vary,"
"e.g. their size, color etc. Schema.org properties can be referenced by their short name"
'e.g. "color"; terms defined elsewhere can be referenced with their URIs.',
)
hasVariant: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a [[Product]] that is a member of this [[ProductGroup]] (or [[ProductModel]]).",
)
productGroupID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates a textual identifier for a ProductGroup.",
)
| 0.935663 | 0.404008 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501f(BaseModel):
"""Nonprofit501f: Non-profit type referring to Cooperative Service Organizations.
References:
https://schema.org/Nonprofit501f
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="Nonprofit501f", 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/Nonprofit501f.py
|
Nonprofit501f.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501f(BaseModel):
"""Nonprofit501f: Non-profit type referring to Cooperative Service Organizations.
References:
https://schema.org/Nonprofit501f
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="Nonprofit501f", 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.945071 | 0.276574 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CompletedActionStatus(BaseModel):
"""An action that has already taken place.
References:
https://schema.org/CompletedActionStatus
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="CompletedActionStatus", 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/CompletedActionStatus.py
|
CompletedActionStatus.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CompletedActionStatus(BaseModel):
"""An action that has already taken place.
References:
https://schema.org/CompletedActionStatus
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="CompletedActionStatus", 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.940939 | 0.306332 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PublicationEvent(BaseModel):
"""A PublicationEvent corresponds indifferently to the event of publication for a CreativeWork of any type, e.g. a broadcast event, an on-demand event, a book/journal publication via a variety of delivery media.
References:
https://schema.org/PublicationEvent
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.
publishedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): An agent associated with the publication event.
free: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
publishedOn: (Optional[Union[List[Union[str, Any]], str, Any]]): A broadcast service associated with the publication event.
"""
type_: str = Field(default="PublicationEvent", 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.",
)
publishedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An agent associated with the publication event.",
)
free: 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.",
)
publishedOn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A broadcast service associated with the publication event.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/PublicationEvent.py
|
PublicationEvent.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PublicationEvent(BaseModel):
"""A PublicationEvent corresponds indifferently to the event of publication for a CreativeWork of any type, e.g. a broadcast event, an on-demand event, a book/journal publication via a variety of delivery media.
References:
https://schema.org/PublicationEvent
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.
publishedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): An agent associated with the publication event.
free: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): A flag to signal that the item, event, or place is accessible for free.
publishedOn: (Optional[Union[List[Union[str, Any]], str, Any]]): A broadcast service associated with the publication event.
"""
type_: str = Field(default="PublicationEvent", 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.",
)
publishedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An agent associated with the publication event.",
)
free: 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.",
)
publishedOn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A broadcast service associated with the publication event.",
)
| 0.934285 | 0.386358 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Quotation(BaseModel):
"""A quotation. Often but not necessarily from some written work, attributable to a real world author and - if associated with a fictional character - to any fictional Person. Use [[isBasedOn]] to link to source/origin. The [[recordedIn]] property can be used to reference a Quotation from an [[Event]].
References:
https://schema.org/Quotation
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.
spokenByCharacter: (Optional[Union[List[Union[str, Any]], str, Any]]): The (e.g. fictional) character, Person or Organization to whom the quotation is attributed within the containing CreativeWork.
"""
type_: str = Field(default="Quotation", 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.",
)
spokenByCharacter: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The (e.g. fictional) character, Person or Organization to whom the quotation is attributed"
"within the containing CreativeWork.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Quotation.py
|
Quotation.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Quotation(BaseModel):
"""A quotation. Often but not necessarily from some written work, attributable to a real world author and - if associated with a fictional character - to any fictional Person. Use [[isBasedOn]] to link to source/origin. The [[recordedIn]] property can be used to reference a Quotation from an [[Event]].
References:
https://schema.org/Quotation
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.
spokenByCharacter: (Optional[Union[List[Union[str, Any]], str, Any]]): The (e.g. fictional) character, Person or Organization to whom the quotation is attributed within the containing CreativeWork.
"""
type_: str = Field(default="Quotation", 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.",
)
spokenByCharacter: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The (e.g. fictional) character, Person or Organization to whom the quotation is attributed"
"within the containing CreativeWork.",
)
| 0.932286 | 0.380183 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class RentAction(BaseModel):
"""The act of giving money in return for temporary use, but not ownership, of an object such as a vehicle or property. For example, an agent rents a property from a landlord in exchange for a periodic payment.
References:
https://schema.org/RentAction
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*.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
priceSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more detailed price specifications, indicating the unit price and delivery or payment charges.
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
realEstateAgent: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of participant. The real estate agent involved in the action.
landlord: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of participant. The owner of the real estate property.
"""
type_: str = Field(default="RentAction", 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*.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
priceSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more detailed price specifications, indicating the unit price and delivery or"
"payment charges.",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
realEstateAgent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of participant. The real estate agent involved in the action.",
)
landlord: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of participant. The owner of the real estate property.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/RentAction.py
|
RentAction.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class RentAction(BaseModel):
"""The act of giving money in return for temporary use, but not ownership, of an object such as a vehicle or property. For example, an agent rents a property from a landlord in exchange for a periodic payment.
References:
https://schema.org/RentAction
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*.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
priceSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more detailed price specifications, indicating the unit price and delivery or payment charges.
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
realEstateAgent: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of participant. The real estate agent involved in the action.
landlord: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of participant. The owner of the real estate property.
"""
type_: str = Field(default="RentAction", 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*.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
priceSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more detailed price specifications, indicating the unit price and delivery or"
"payment charges.",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
realEstateAgent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of participant. The real estate agent involved in the action.",
)
landlord: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of participant. The owner of the real estate property.",
)
| 0.922561 | 0.414899 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Virus(BaseModel):
"""Pathogenic virus that causes viral infection.
References:
https://schema.org/Virus
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="Virus", 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/Virus.py
|
Virus.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Virus(BaseModel):
"""Pathogenic virus that causes viral infection.
References:
https://schema.org/Virus
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="Virus", 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.940264 | 0.313131 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ParentAudience(BaseModel):
"""A set of characteristics describing parents, who can be interested in viewing some content.
References:
https://schema.org/ParentAudience
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.
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.
childMinAge: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): Minimal age of the child.
childMaxAge: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): Maximal age of the child.
"""
type_: str = Field(default="ParentAudience", 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.",
)
childMinAge: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="Minimal age of the child.",
)
childMaxAge: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="Maximal age of the child.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/ParentAudience.py
|
ParentAudience.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ParentAudience(BaseModel):
"""A set of characteristics describing parents, who can be interested in viewing some content.
References:
https://schema.org/ParentAudience
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.
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.
childMinAge: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): Minimal age of the child.
childMaxAge: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): Maximal age of the child.
"""
type_: str = Field(default="ParentAudience", 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.",
)
childMinAge: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="Minimal age of the child.",
)
childMaxAge: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="Maximal age of the child.",
)
| 0.931967 | 0.391493 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ReservationConfirmed(BaseModel):
"""The status of a confirmed reservation.
References:
https://schema.org/ReservationConfirmed
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="ReservationConfirmed", 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/ReservationConfirmed.py
|
ReservationConfirmed.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ReservationConfirmed(BaseModel):
"""The status of a confirmed reservation.
References:
https://schema.org/ReservationConfirmed
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="ReservationConfirmed", 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.945739 | 0.314801 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c14(BaseModel):
"""Nonprofit501c14: Non-profit type referring to State-Chartered Credit Unions, Mutual Reserve Funds.
References:
https://schema.org/Nonprofit501c14
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="Nonprofit501c14", 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/Nonprofit501c14.py
|
Nonprofit501c14.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c14(BaseModel):
"""Nonprofit501c14: Non-profit type referring to State-Chartered Credit Unions, Mutual Reserve Funds.
References:
https://schema.org/Nonprofit501c14
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="Nonprofit501c14", 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.944779 | 0.267059 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HealthTopicContent(BaseModel):
"""[[HealthTopicContent]] is [[WebContent]] that is about some aspect of a health topic, e.g. a condition, its symptoms or treatments. Such content may be comprised of several parts or sections and use different types of media. Multiple instances of [[WebContent]] (and hence [[HealthTopicContent]]) can be related using [[hasPart]] / [[isPartOf]] where there is some kind of content hierarchy, and their content described with [[about]] and [[mentions]] e.g. building upon the existing [[MedicalCondition]] vocabulary.
References:
https://schema.org/HealthTopicContent
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.
hasHealthAspect: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the aspect or aspects specifically addressed in some [[HealthTopicContent]]. For example, that the content is an overview, or that it talks about treatment, self-care, treatments or their side-effects.
"""
type_: str = Field(default="HealthTopicContent", 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.",
)
hasHealthAspect: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the aspect or aspects specifically addressed in some [[HealthTopicContent]]."
"For example, that the content is an overview, or that it talks about treatment, self-care,"
"treatments or their side-effects.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/HealthTopicContent.py
|
HealthTopicContent.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HealthTopicContent(BaseModel):
"""[[HealthTopicContent]] is [[WebContent]] that is about some aspect of a health topic, e.g. a condition, its symptoms or treatments. Such content may be comprised of several parts or sections and use different types of media. Multiple instances of [[WebContent]] (and hence [[HealthTopicContent]]) can be related using [[hasPart]] / [[isPartOf]] where there is some kind of content hierarchy, and their content described with [[about]] and [[mentions]] e.g. building upon the existing [[MedicalCondition]] vocabulary.
References:
https://schema.org/HealthTopicContent
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.
hasHealthAspect: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the aspect or aspects specifically addressed in some [[HealthTopicContent]]. For example, that the content is an overview, or that it talks about treatment, self-care, treatments or their side-effects.
"""
type_: str = Field(default="HealthTopicContent", 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.",
)
hasHealthAspect: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the aspect or aspects specifically addressed in some [[HealthTopicContent]]."
"For example, that the content is an overview, or that it talks about treatment, self-care,"
"treatments or their side-effects.",
)
| 0.935781 | 0.351645 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class FilmAction(BaseModel):
"""The act of capturing sound and moving images on film, video, or digitally.
References:
https://schema.org/FilmAction
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*.
"""
type_: str = Field(default="FilmAction", 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/FilmAction.py
|
FilmAction.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class FilmAction(BaseModel):
"""The act of capturing sound and moving images on film, video, or digitally.
References:
https://schema.org/FilmAction
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*.
"""
type_: str = Field(default="FilmAction", 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.935391 | 0.407216 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SellAction(BaseModel):
"""The act of taking money from a buyer in exchange for goods or services rendered. An agent sells an object, product, or service to a buyer for a price. Reciprocal of BuyAction.
References:
https://schema.org/SellAction
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*.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
priceSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more detailed price specifications, indicating the unit price and delivery or payment charges.
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
buyer: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of participant. The participant/person/organization that bought the object.
warrantyPromise: (Optional[Union[List[Union[str, Any]], str, Any]]): The warranty promise(s) included in the offer.
"""
type_: str = Field(default="SellAction", 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*.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
priceSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more detailed price specifications, indicating the unit price and delivery or"
"payment charges.",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
buyer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of participant. The participant/person/organization that bought the"
"object.",
)
warrantyPromise: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The warranty promise(s) included in the offer.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/SellAction.py
|
SellAction.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SellAction(BaseModel):
"""The act of taking money from a buyer in exchange for goods or services rendered. An agent sells an object, product, or service to a buyer for a price. Reciprocal of BuyAction.
References:
https://schema.org/SellAction
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*.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
priceSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more detailed price specifications, indicating the unit price and delivery or payment charges.
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
buyer: (Optional[Union[List[Union[str, Any]], str, Any]]): A sub property of participant. The participant/person/organization that bought the object.
warrantyPromise: (Optional[Union[List[Union[str, Any]], str, Any]]): The warranty promise(s) included in the offer.
"""
type_: str = Field(default="SellAction", 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*.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
priceSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more detailed price specifications, indicating the unit price and delivery or"
"payment charges.",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
buyer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sub property of participant. The participant/person/organization that bought the"
"object.",
)
warrantyPromise: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The warranty promise(s) included in the offer.",
)
| 0.922495 | 0.422981 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalCondition(BaseModel):
"""Any condition of the human body that affects the normal functioning of a person, whether physically or mentally. Includes diseases, injuries, disabilities, disorders, syndromes, etc.
References:
https://schema.org/MedicalCondition
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.
riskFactor: (Optional[Union[List[Union[str, Any]], str, Any]]): A modifiable or non-modifiable factor that increases the risk of a patient contracting this condition, e.g. age, coexisting condition.
primaryPrevention: (Optional[Union[List[Union[str, Any]], str, Any]]): A preventative therapy used to prevent an initial occurrence of the medical condition, such as vaccination.
expectedPrognosis: (Union[List[Union[str, Any]], str, Any]): The likely outcome in either the short term or long term of the medical condition.
typicalTest: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical test typically performed given this condition.
differentialDiagnosis: (Optional[Union[List[Union[str, Any]], str, Any]]): One of a set of differential diagnoses for the condition. Specifically, a closely-related or competing diagnosis typically considered later in the cognitive process whereby this medical condition is distinguished from others most likely responsible for a similar collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses in a patient.
pathophysiology: (Union[List[Union[str, Any]], str, Any]): Changes in the normal mechanical, physical, and biochemical functions that are associated with this activity or condition.
status: (Union[List[Union[str, Any]], str, Any]): The status of the study (enumerated).
naturalProgression: (Union[List[Union[str, Any]], str, Any]): The expected progression of the condition if it is not treated and allowed to progress naturally.
drug: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifying a drug or medicine used in a medication procedure.
secondaryPrevention: (Optional[Union[List[Union[str, Any]], str, Any]]): A preventative therapy used to prevent reoccurrence of the medical condition after an initial episode of the condition.
signOrSymptom: (Optional[Union[List[Union[str, Any]], str, Any]]): A sign or symptom of this condition. Signs are objective or physically observable manifestations of the medical condition while symptoms are the subjective experience of the medical condition.
possibleTreatment: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible treatment to address this condition, sign or symptom.
epidemiology: (Union[List[Union[str, Any]], str, Any]): The characteristics of associated patients, such as age, gender, race etc.
associatedAnatomy: (Optional[Union[List[Union[str, Any]], str, Any]]): The anatomy of the underlying organ system or structures associated with this entity.
possibleComplication: (Union[List[Union[str, Any]], str, Any]): A possible unexpected and unfavorable evolution of a medical condition. Complications may include worsening of the signs or symptoms of the disease, extension of the condition to other organ systems, etc.
stage: (Optional[Union[List[Union[str, Any]], str, Any]]): The stage of the condition, if applicable.
"""
type_: str = Field(default="MedicalCondition", 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.",
)
riskFactor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A modifiable or non-modifiable factor that increases the risk of a patient contracting"
"this condition, e.g. age, coexisting condition.",
)
primaryPrevention: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A preventative therapy used to prevent an initial occurrence of the medical condition,"
"such as vaccination.",
)
expectedPrognosis: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The likely outcome in either the short term or long term of the medical condition.",
)
typicalTest: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical test typically performed given this condition.",
)
differentialDiagnosis: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One of a set of differential diagnoses for the condition. Specifically, a closely-related"
"or competing diagnosis typically considered later in the cognitive process whereby"
"this medical condition is distinguished from others most likely responsible for a similar"
"collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses"
"in a patient.",
)
pathophysiology: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Changes in the normal mechanical, physical, and biochemical functions that are associated"
"with this activity or condition.",
)
status: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of the study (enumerated).",
)
naturalProgression: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The expected progression of the condition if it is not treated and allowed to progress"
"naturally.",
)
drug: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifying a drug or medicine used in a medication procedure.",
)
secondaryPrevention: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A preventative therapy used to prevent reoccurrence of the medical condition after"
"an initial episode of the condition.",
)
signOrSymptom: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sign or symptom of this condition. Signs are objective or physically observable manifestations"
"of the medical condition while symptoms are the subjective experience of the medical"
"condition.",
)
possibleTreatment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible treatment to address this condition, sign or symptom.",
)
epidemiology: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The characteristics of associated patients, such as age, gender, race etc.",
)
associatedAnatomy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The anatomy of the underlying organ system or structures associated with this entity.",
)
possibleComplication: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A possible unexpected and unfavorable evolution of a medical condition. Complications"
"may include worsening of the signs or symptoms of the disease, extension of the condition"
"to other organ systems, etc.",
)
stage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The stage of the condition, if applicable.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MedicalCondition.py
|
MedicalCondition.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalCondition(BaseModel):
"""Any condition of the human body that affects the normal functioning of a person, whether physically or mentally. Includes diseases, injuries, disabilities, disorders, syndromes, etc.
References:
https://schema.org/MedicalCondition
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.
riskFactor: (Optional[Union[List[Union[str, Any]], str, Any]]): A modifiable or non-modifiable factor that increases the risk of a patient contracting this condition, e.g. age, coexisting condition.
primaryPrevention: (Optional[Union[List[Union[str, Any]], str, Any]]): A preventative therapy used to prevent an initial occurrence of the medical condition, such as vaccination.
expectedPrognosis: (Union[List[Union[str, Any]], str, Any]): The likely outcome in either the short term or long term of the medical condition.
typicalTest: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical test typically performed given this condition.
differentialDiagnosis: (Optional[Union[List[Union[str, Any]], str, Any]]): One of a set of differential diagnoses for the condition. Specifically, a closely-related or competing diagnosis typically considered later in the cognitive process whereby this medical condition is distinguished from others most likely responsible for a similar collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses in a patient.
pathophysiology: (Union[List[Union[str, Any]], str, Any]): Changes in the normal mechanical, physical, and biochemical functions that are associated with this activity or condition.
status: (Union[List[Union[str, Any]], str, Any]): The status of the study (enumerated).
naturalProgression: (Union[List[Union[str, Any]], str, Any]): The expected progression of the condition if it is not treated and allowed to progress naturally.
drug: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifying a drug or medicine used in a medication procedure.
secondaryPrevention: (Optional[Union[List[Union[str, Any]], str, Any]]): A preventative therapy used to prevent reoccurrence of the medical condition after an initial episode of the condition.
signOrSymptom: (Optional[Union[List[Union[str, Any]], str, Any]]): A sign or symptom of this condition. Signs are objective or physically observable manifestations of the medical condition while symptoms are the subjective experience of the medical condition.
possibleTreatment: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible treatment to address this condition, sign or symptom.
epidemiology: (Union[List[Union[str, Any]], str, Any]): The characteristics of associated patients, such as age, gender, race etc.
associatedAnatomy: (Optional[Union[List[Union[str, Any]], str, Any]]): The anatomy of the underlying organ system or structures associated with this entity.
possibleComplication: (Union[List[Union[str, Any]], str, Any]): A possible unexpected and unfavorable evolution of a medical condition. Complications may include worsening of the signs or symptoms of the disease, extension of the condition to other organ systems, etc.
stage: (Optional[Union[List[Union[str, Any]], str, Any]]): The stage of the condition, if applicable.
"""
type_: str = Field(default="MedicalCondition", 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.",
)
riskFactor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A modifiable or non-modifiable factor that increases the risk of a patient contracting"
"this condition, e.g. age, coexisting condition.",
)
primaryPrevention: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A preventative therapy used to prevent an initial occurrence of the medical condition,"
"such as vaccination.",
)
expectedPrognosis: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The likely outcome in either the short term or long term of the medical condition.",
)
typicalTest: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical test typically performed given this condition.",
)
differentialDiagnosis: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One of a set of differential diagnoses for the condition. Specifically, a closely-related"
"or competing diagnosis typically considered later in the cognitive process whereby"
"this medical condition is distinguished from others most likely responsible for a similar"
"collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses"
"in a patient.",
)
pathophysiology: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Changes in the normal mechanical, physical, and biochemical functions that are associated"
"with this activity or condition.",
)
status: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of the study (enumerated).",
)
naturalProgression: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The expected progression of the condition if it is not treated and allowed to progress"
"naturally.",
)
drug: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifying a drug or medicine used in a medication procedure.",
)
secondaryPrevention: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A preventative therapy used to prevent reoccurrence of the medical condition after"
"an initial episode of the condition.",
)
signOrSymptom: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sign or symptom of this condition. Signs are objective or physically observable manifestations"
"of the medical condition while symptoms are the subjective experience of the medical"
"condition.",
)
possibleTreatment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible treatment to address this condition, sign or symptom.",
)
epidemiology: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The characteristics of associated patients, such as age, gender, race etc.",
)
associatedAnatomy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The anatomy of the underlying organ system or structures associated with this entity.",
)
possibleComplication: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A possible unexpected and unfavorable evolution of a medical condition. Complications"
"may include worsening of the signs or symptoms of the disease, extension of the condition"
"to other organ systems, etc.",
)
stage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The stage of the condition, if applicable.",
)
| 0.930237 | 0.441613 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TechArticle(BaseModel):
"""A technical article - Example: How-to (task) topics, step-by-step, procedural troubleshooting, specifications, etc.
References:
https://schema.org/TechArticle
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.
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".
proficiencyLevel: (Union[List[Union[str, Any]], str, Any]): Proficiency needed for this content; expected values: 'Beginner', 'Expert'.
dependencies: (Union[List[Union[str, Any]], str, Any]): Prerequisites needed to fulfill steps in article.
"""
type_: str = Field(default="TechArticle", 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".',
)
proficiencyLevel: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Proficiency needed for this content; expected values: 'Beginner', 'Expert'.",
)
dependencies: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Prerequisites needed to fulfill steps in article.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/TechArticle.py
|
TechArticle.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TechArticle(BaseModel):
"""A technical article - Example: How-to (task) topics, step-by-step, procedural troubleshooting, specifications, etc.
References:
https://schema.org/TechArticle
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.
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".
proficiencyLevel: (Union[List[Union[str, Any]], str, Any]): Proficiency needed for this content; expected values: 'Beginner', 'Expert'.
dependencies: (Union[List[Union[str, Any]], str, Any]): Prerequisites needed to fulfill steps in article.
"""
type_: str = Field(default="TechArticle", 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".',
)
proficiencyLevel: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Proficiency needed for this content; expected values: 'Beginner', 'Expert'.",
)
dependencies: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Prerequisites needed to fulfill steps in article.",
)
| 0.917552 | 0.322553 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HyperTocEntry(BaseModel):
"""A HyperToEntry is an item within a [[HyperToc]], which represents a hypertext table of contents for complex media objects, such as [[VideoObject]], [[AudioObject]]. The media object itself is indicated using [[associatedMedia]]. Each section of interest within that content can be described with a [[HyperTocEntry]], with associated [[startOffset]] and [[endOffset]]. When several entries are all from the same file, [[associatedMedia]] is used on the overarching [[HyperTocEntry]]; if the content has been split into multiple files, they can be referenced using [[associatedMedia]] on each [[HyperTocEntry]].
References:
https://schema.org/HyperTocEntry
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.
utterances: (Union[List[Union[str, Any]], str, Any]): Text of an utterances (spoken words, lyrics etc.) that occurs at a certain section of a media object, represented as a [[HyperTocEntry]].
tocContinuation: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[HyperTocEntry]] can have a [[tocContinuation]] indicated, which is another [[HyperTocEntry]] that would be the default next item to play or render.
"""
type_: str = Field(default="HyperTocEntry", 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.",
)
utterances: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of an utterances (spoken words, lyrics etc.) that occurs at a certain section of"
"a media object, represented as a [[HyperTocEntry]].",
)
tocContinuation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[HyperTocEntry]] can have a [[tocContinuation]] indicated, which is another [[HyperTocEntry]]"
"that would be the default next item to play or render.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/HyperTocEntry.py
|
HyperTocEntry.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HyperTocEntry(BaseModel):
"""A HyperToEntry is an item within a [[HyperToc]], which represents a hypertext table of contents for complex media objects, such as [[VideoObject]], [[AudioObject]]. The media object itself is indicated using [[associatedMedia]]. Each section of interest within that content can be described with a [[HyperTocEntry]], with associated [[startOffset]] and [[endOffset]]. When several entries are all from the same file, [[associatedMedia]] is used on the overarching [[HyperTocEntry]]; if the content has been split into multiple files, they can be referenced using [[associatedMedia]] on each [[HyperTocEntry]].
References:
https://schema.org/HyperTocEntry
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.
utterances: (Union[List[Union[str, Any]], str, Any]): Text of an utterances (spoken words, lyrics etc.) that occurs at a certain section of a media object, represented as a [[HyperTocEntry]].
tocContinuation: (Optional[Union[List[Union[str, Any]], str, Any]]): A [[HyperTocEntry]] can have a [[tocContinuation]] indicated, which is another [[HyperTocEntry]] that would be the default next item to play or render.
"""
type_: str = Field(default="HyperTocEntry", 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.",
)
utterances: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Text of an utterances (spoken words, lyrics etc.) that occurs at a certain section of"
"a media object, represented as a [[HyperTocEntry]].",
)
tocContinuation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A [[HyperTocEntry]] can have a [[tocContinuation]] indicated, which is another [[HyperTocEntry]]"
"that would be the default next item to play or render.",
)
| 0.93488 | 0.414899 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HardwareStore(BaseModel):
"""A hardware store.
References:
https://schema.org/HardwareStore
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="HardwareStore", 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/HardwareStore.py
|
HardwareStore.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HardwareStore(BaseModel):
"""A hardware store.
References:
https://schema.org/HardwareStore
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="HardwareStore", 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.876502 | 0.292981 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableSizeGroupInfants(BaseModel):
"""Size group "Infants" for wearables.
References:
https://schema.org/WearableSizeGroupInfants
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="WearableSizeGroupInfants", 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/WearableSizeGroupInfants.py
|
WearableSizeGroupInfants.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableSizeGroupInfants(BaseModel):
"""Size group "Infants" for wearables.
References:
https://schema.org/WearableSizeGroupInfants
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="WearableSizeGroupInfants", 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.942942 | 0.305076 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Protozoa(BaseModel):
"""Single-celled organism that causes an infection.
References:
https://schema.org/Protozoa
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="Protozoa", 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/Protozoa.py
|
Protozoa.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Protozoa(BaseModel):
"""Single-celled organism that causes an infection.
References:
https://schema.org/Protozoa
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="Protozoa", 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.943243 | 0.323594 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalGuidelineRecommendation(BaseModel):
"""A guideline recommendation that is regarded as efficacious and where quality of the data supporting the recommendation is sound.
References:
https://schema.org/MedicalGuidelineRecommendation
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.
evidenceLevel: (Optional[Union[List[Union[str, Any]], str, Any]]): Strength of evidence of the data used to formulate the guideline (enumerated).
guidelineSubject: (Optional[Union[List[Union[str, Any]], str, Any]]): The medical conditions, treatments, etc. that are the subject of the guideline.
guidelineDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Date on which this guideline's recommendation was made.
evidenceOrigin: (Union[List[Union[str, Any]], str, Any]): Source of the data used to formulate the guidance, e.g. RCT, consensus opinion, etc.
recommendationStrength: (Union[List[Union[str, Any]], str, Any]): Strength of the guideline's recommendation (e.g. 'class I').
"""
type_: str = Field(
default="MedicalGuidelineRecommendation", 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.",
)
evidenceLevel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Strength of evidence of the data used to formulate the guideline (enumerated).",
)
guidelineSubject: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The medical conditions, treatments, etc. that are the subject of the guideline.",
)
guidelineDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="Date on which this guideline's recommendation was made.",
)
evidenceOrigin: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Source of the data used to formulate the guidance, e.g. RCT, consensus opinion, etc.",
)
recommendationStrength: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Strength of the guideline's recommendation (e.g. 'class I').",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MedicalGuidelineRecommendation.py
|
MedicalGuidelineRecommendation.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalGuidelineRecommendation(BaseModel):
"""A guideline recommendation that is regarded as efficacious and where quality of the data supporting the recommendation is sound.
References:
https://schema.org/MedicalGuidelineRecommendation
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.
evidenceLevel: (Optional[Union[List[Union[str, Any]], str, Any]]): Strength of evidence of the data used to formulate the guideline (enumerated).
guidelineSubject: (Optional[Union[List[Union[str, Any]], str, Any]]): The medical conditions, treatments, etc. that are the subject of the guideline.
guidelineDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Date on which this guideline's recommendation was made.
evidenceOrigin: (Union[List[Union[str, Any]], str, Any]): Source of the data used to formulate the guidance, e.g. RCT, consensus opinion, etc.
recommendationStrength: (Union[List[Union[str, Any]], str, Any]): Strength of the guideline's recommendation (e.g. 'class I').
"""
type_: str = Field(
default="MedicalGuidelineRecommendation", 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.",
)
evidenceLevel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Strength of evidence of the data used to formulate the guideline (enumerated).",
)
guidelineSubject: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The medical conditions, treatments, etc. that are the subject of the guideline.",
)
guidelineDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="Date on which this guideline's recommendation was made.",
)
evidenceOrigin: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Source of the data used to formulate the guidance, e.g. RCT, consensus opinion, etc.",
)
recommendationStrength: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Strength of the guideline's recommendation (e.g. 'class I').",
)
| 0.925158 | 0.380529 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Dermatologic(BaseModel):
"""Something relating to or practicing dermatology.
References:
https://schema.org/Dermatologic
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="Dermatologic", 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/Dermatologic.py
|
Dermatologic.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Dermatologic(BaseModel):
"""Something relating to or practicing dermatology.
References:
https://schema.org/Dermatologic
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="Dermatologic", 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.934597 | 0.374791 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EnergyEfficiencyEnumeration(BaseModel):
"""Enumerates energy efficiency levels (also known as "classes" or "ratings") and certifications that are part of several international energy efficiency standards.
References:
https://schema.org/EnergyEfficiencyEnumeration
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="EnergyEfficiencyEnumeration", 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/EnergyEfficiencyEnumeration.py
|
EnergyEfficiencyEnumeration.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class EnergyEfficiencyEnumeration(BaseModel):
"""Enumerates energy efficiency levels (also known as "classes" or "ratings") and certifications that are part of several international energy efficiency standards.
References:
https://schema.org/EnergyEfficiencyEnumeration
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="EnergyEfficiencyEnumeration", 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.947345 | 0.333246 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TouristInformationCenter(BaseModel):
"""A tourist information center.
References:
https://schema.org/TouristInformationCenter
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.
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="TouristInformationCenter", 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/TouristInformationCenter.py
|
TouristInformationCenter.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TouristInformationCenter(BaseModel):
"""A tourist information center.
References:
https://schema.org/TouristInformationCenter
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.
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="TouristInformationCenter", 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.852552 | 0.363534 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ComputerStore(BaseModel):
"""A computer store.
References:
https://schema.org/ComputerStore
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="ComputerStore", 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/ComputerStore.py
|
ComputerStore.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ComputerStore(BaseModel):
"""A computer store.
References:
https://schema.org/ComputerStore
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="ComputerStore", 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.884875 | 0.350671 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ParcelService(BaseModel):
"""A private parcel service as the delivery mode available for a certain offer.Commonly used values:* http://purl.org/goodrelations/v1#DHL* http://purl.org/goodrelations/v1#FederalExpress* http://purl.org/goodrelations/v1#UPS
References:
https://schema.org/ParcelService
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="ParcelService", 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/ParcelService.py
|
ParcelService.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ParcelService(BaseModel):
"""A private parcel service as the delivery mode available for a certain offer.Commonly used values:* http://purl.org/goodrelations/v1#DHL* http://purl.org/goodrelations/v1#FederalExpress* http://purl.org/goodrelations/v1#UPS
References:
https://schema.org/ParcelService
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="ParcelService", 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.942115 | 0.302835 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HowToSection(BaseModel):
"""A sub-grouping of steps in the instructions for how to achieve a result (e.g. steps for making a pie crust within a pie recipe).
References:
https://schema.org/HowToSection
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.
itemListOrder: (Union[List[Union[str, Any]], str, Any]): Type of ordering (e.g. Ascending, Descending, Unordered).
numberOfItems: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list.
itemListElement: (Union[List[Union[str, Any]], str, Any]): For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.Text values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.Note: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases.
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.
item: (Optional[Union[List[Union[str, Any]], str, Any]]): An entity represented by an entry in a list or data feed (e.g. an 'artist' in a list of 'artists').
nextItem: (Optional[Union[List[Union[str, Any]], str, Any]]): A link to the ListItem that follows the current one.
previousItem: (Optional[Union[List[Union[str, Any]], str, Any]]): A link to the ListItem that precedes the current one.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
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.
steps: (Union[List[Union[str, Any]], str, Any]): A single step item (as HowToStep, text, document, video, etc.) or a HowToSection (originally misnamed 'steps'; 'step' is preferred).
"""
type_: str = Field(default="HowToSection", 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.",
)
itemListOrder: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Type of ordering (e.g. Ascending, Descending, Unordered).",
)
numberOfItems: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of items in an ItemList. Note that some descriptions might not fully describe"
"all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems"
"would be for the entire list.",
)
itemListElement: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='For itemListElement values, you can use simple strings (e.g. "Peter", "Paul",'
'"Mary"), existing entities, or use ListItem.Text values are best if the elements'
"in the list are plain strings. Existing entities are best for a simple, unordered list"
"of existing things in your data. ListItem is used with ordered lists when you want to provide"
"additional context about the element in that list or when the same item might be in different"
"places in different lists.Note: The order of elements in your mark-up is not sufficient"
"for indicating the order or elements. Use ListItem with a 'position' property in such"
"cases.",
)
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.",
)
item: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An entity represented by an entry in a list or data feed (e.g. an 'artist' in a list of 'artists').",
)
nextItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A link to the ListItem that follows the current one.",
)
previousItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A link to the ListItem that precedes the current one.",
)
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.",
)
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.",
)
steps: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A single step item (as HowToStep, text, document, video, etc.) or a HowToSection (originally"
"misnamed 'steps'; 'step' is preferred).",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/HowToSection.py
|
HowToSection.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class HowToSection(BaseModel):
"""A sub-grouping of steps in the instructions for how to achieve a result (e.g. steps for making a pie crust within a pie recipe).
References:
https://schema.org/HowToSection
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.
itemListOrder: (Union[List[Union[str, Any]], str, Any]): Type of ordering (e.g. Ascending, Descending, Unordered).
numberOfItems: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list.
itemListElement: (Union[List[Union[str, Any]], str, Any]): For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.Text values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.Note: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases.
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.
item: (Optional[Union[List[Union[str, Any]], str, Any]]): An entity represented by an entry in a list or data feed (e.g. an 'artist' in a list of 'artists').
nextItem: (Optional[Union[List[Union[str, Any]], str, Any]]): A link to the ListItem that follows the current one.
previousItem: (Optional[Union[List[Union[str, Any]], str, Any]]): A link to the ListItem that precedes the current one.
position: (Union[List[Union[str, int, Any]], str, int, Any]): The position of an item in a series or sequence of items.
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.
steps: (Union[List[Union[str, Any]], str, Any]): A single step item (as HowToStep, text, document, video, etc.) or a HowToSection (originally misnamed 'steps'; 'step' is preferred).
"""
type_: str = Field(default="HowToSection", 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.",
)
itemListOrder: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Type of ordering (e.g. Ascending, Descending, Unordered).",
)
numberOfItems: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of items in an ItemList. Note that some descriptions might not fully describe"
"all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems"
"would be for the entire list.",
)
itemListElement: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='For itemListElement values, you can use simple strings (e.g. "Peter", "Paul",'
'"Mary"), existing entities, or use ListItem.Text values are best if the elements'
"in the list are plain strings. Existing entities are best for a simple, unordered list"
"of existing things in your data. ListItem is used with ordered lists when you want to provide"
"additional context about the element in that list or when the same item might be in different"
"places in different lists.Note: The order of elements in your mark-up is not sufficient"
"for indicating the order or elements. Use ListItem with a 'position' property in such"
"cases.",
)
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.",
)
item: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An entity represented by an entry in a list or data feed (e.g. an 'artist' in a list of 'artists').",
)
nextItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A link to the ListItem that follows the current one.",
)
previousItem: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A link to the ListItem that precedes the current one.",
)
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.",
)
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.",
)
steps: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A single step item (as HowToStep, text, document, video, etc.) or a HowToSection (originally"
"misnamed 'steps'; 'step' is preferred).",
)
| 0.915186 | 0.436382 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Mosque(BaseModel):
"""A mosque.
References:
https://schema.org/Mosque
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).
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="Mosque", 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>.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Mosque.py
|
Mosque.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Mosque(BaseModel):
"""A mosque.
References:
https://schema.org/Mosque
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).
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="Mosque", 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>.",
)
| 0.941909 | 0.523116 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Mountain(BaseModel):
"""A mountain, like Mount Whitney or Mount Everest.
References:
https://schema.org/Mountain
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="Mountain", 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/Mountain.py
|
Mountain.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Mountain(BaseModel):
"""A mountain, like Mount Whitney or Mount Everest.
References:
https://schema.org/Mountain
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="Mountain", 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.939782 | 0.569015 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Seat(BaseModel):
"""Used to describe a seat, such as a reserved seat in an event reservation.
References:
https://schema.org/Seat
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.
seatSection: (Union[List[Union[str, Any]], str, Any]): The section location of the reserved seat (e.g. Orchestra).
seatNumber: (Union[List[Union[str, Any]], str, Any]): The location of the reserved seat (e.g., 27).
seatingType: (Union[List[Union[str, Any]], str, Any]): The type/class of the seat.
seatRow: (Union[List[Union[str, Any]], str, Any]): The row location of the reserved seat (e.g., B).
"""
type_: str = Field(default="Seat", 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.",
)
seatSection: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The section location of the reserved seat (e.g. Orchestra).",
)
seatNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of the reserved seat (e.g., 27).",
)
seatingType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The type/class of the seat.",
)
seatRow: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The row location of the reserved seat (e.g., B).",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Seat.py
|
Seat.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Seat(BaseModel):
"""Used to describe a seat, such as a reserved seat in an event reservation.
References:
https://schema.org/Seat
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.
seatSection: (Union[List[Union[str, Any]], str, Any]): The section location of the reserved seat (e.g. Orchestra).
seatNumber: (Union[List[Union[str, Any]], str, Any]): The location of the reserved seat (e.g., 27).
seatingType: (Union[List[Union[str, Any]], str, Any]): The type/class of the seat.
seatRow: (Union[List[Union[str, Any]], str, Any]): The row location of the reserved seat (e.g., B).
"""
type_: str = Field(default="Seat", 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.",
)
seatSection: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The section location of the reserved seat (e.g. Orchestra).",
)
seatNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The location of the reserved seat (e.g., 27).",
)
seatingType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The type/class of the seat.",
)
seatRow: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The row location of the reserved seat (e.g., B).",
)
| 0.949435 | 0.332839 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Neck(BaseModel):
"""Neck assessment with clinical examination.
References:
https://schema.org/Neck
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.
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="Neck", 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.",
)
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/Neck.py
|
Neck.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Neck(BaseModel):
"""Neck assessment with clinical examination.
References:
https://schema.org/Neck
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.
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="Neck", 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.",
)
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.909936 | 0.353456 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Date(BaseModel):
"""A date value in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
References:
https://schema.org/Date
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="Date", 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/Date.py
|
Date.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Date(BaseModel):
"""A date value in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).
References:
https://schema.org/Date
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="Date", 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.946868 | 0.372163 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalResearcher(BaseModel):
"""Medical researchers.
References:
https://schema.org/MedicalResearcher
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="MedicalResearcher", 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/MedicalResearcher.py
|
MedicalResearcher.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalResearcher(BaseModel):
"""Medical researchers.
References:
https://schema.org/MedicalResearcher
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="MedicalResearcher", 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.940285 | 0.320316 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ProductModel(BaseModel):
"""A datasheet or vendor specification of a product (in the sense of a prototypical description).
References:
https://schema.org/ProductModel
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.
hasMeasurement: (Optional[Union[List[Union[str, Any]], str, Any]]): A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.
countryOfAssembly: (Union[List[Union[str, Any]], str, Any]): The place where the product was assembled.
width: (Optional[Union[List[Union[str, Any]], str, Any]]): The width of the item.
isAccessoryOrSparePartFor: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another product (or multiple products) for which this product is an accessory or spare part.
isConsumableFor: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another product (or multiple products) for which this product is a consumable.
depth: (Optional[Union[List[Union[str, Any]], str, Any]]): The depth of the item.
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.
isVariantOf: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
manufacturer: (Optional[Union[List[Union[str, Any]], str, Any]]): The manufacturer of the product.
gtin14: (Union[List[Union[str, Any]], str, Any]): The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
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.
positiveNotes: (Union[List[Union[str, Any]], str, Any]): Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described.The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
height: (Optional[Union[List[Union[str, Any]], str, Any]]): The height of the item.
model: (Union[List[Union[str, Any]], str, Any]): The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.
itemCondition: (Optional[Union[List[Union[str, Any]], str, Any]]): A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
nsn: (Union[List[Union[str, Any]], str, Any]): Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [[Product]].
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.
gtin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809) for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.
isRelatedTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, somehow related product (or multiple products).
negativeNotes: (Union[List[Union[str, Any]], str, Any]): Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]].The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).
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]].
mobileUrl: (Union[List[Union[str, Any]], str, Any]): The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.
hasEnergyConsumptionDetails: (Optional[Union[List[Union[str, Any]], str, Any]]): Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.
weight: (Optional[Union[List[Union[str, Any]], str, Any]]): The weight of the product or person.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
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.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
gtin12: (Union[List[Union[str, Any]], str, Any]): The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
isSimilarTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, functionally similar product (or multiple products).
productID: (Union[List[Union[str, Any]], str, Any]): The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```.
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.
hasAdultConsideration: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to tag an item to be intended or suitable for consumption or use by adults only.
purchaseDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date the item, e.g. vehicle, was purchased by the current owner.
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.
countryOfLastProcessing: (Union[List[Union[str, Any]], str, Any]): The place where the item (typically [[Product]]) was last processed and tested before importation.
asin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s article).Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details.ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.
gtin8: (Union[List[Union[str, Any]], str, Any]): The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
releaseDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The release date of a product or product model. This can be used to distinguish the exact variant of a product.
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.
productionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date of production of the item, e.g. vehicle.
inProductGroupWithID: (Union[List[Union[str, Any]], str, Any]): Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].
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.
mpn: (Union[List[Union[str, Any]], str, Any]): The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
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.
color: (Union[List[Union[str, Any]], str, Any]): The color of the product.
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
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.
gtin13: (Union[List[Union[str, Any]], str, Any]): The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
sku: (Union[List[Union[str, Any]], str, Any]): The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
isVariantOf: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group.
successorOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer from a newer variant of a product to its previous, often discontinued predecessor.
predecessorOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer from a previous, often discontinued variant of the product to its newer variant.
"""
type_: str = Field(default="ProductModel", 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.",
)
hasMeasurement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A product measurement, for example the inseam of pants, the wheel size of a bicycle, or"
"the gauge of a screw. Usually an exact measurement, but can also be a range of measurements"
"for adjustable products, for example belts and ski bindings.",
)
countryOfAssembly: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The place where the product was assembled.",
)
width: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The width of the item.",
)
isAccessoryOrSparePartFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another product (or multiple products) for which this product is an accessory"
"or spare part.",
)
isConsumableFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another product (or multiple products) for which this product is a consumable.",
)
depth: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The depth of the item.",
)
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.",
)
isVariantOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the kind of product that this is a variant of. In the case of [[ProductModel]],"
"this is a pointer (from a ProductModel) to a base product from which this product is a variant."
"It is safe to infer that the variant inherits all product features from the base model,"
"unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the"
"group description also serves as a template, representing a set of Products that vary"
"on explicitly defined, specific dimensions only (so it defines both a set of variants,"
"as well as which values distinguish amongst those variants). When used with [[ProductGroup]],"
"this property can apply to any [[Product]] included in the group.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
manufacturer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The manufacturer of the product.",
)
gtin14: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN"
"Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.",
)
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.",
)
positiveNotes: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Provides positive considerations regarding something, for example product highlights"
"or (alongside [[negativeNotes]]) pro/con lists for reviews.In the case of a [[Review]],"
"the property describes the [[itemReviewed]] from the perspective of the review; in"
"the case of a [[Product]], the product itself is being described.The property values"
"can be expressed either as unstructured text (repeated as necessary), or if ordered,"
"as a list (in which case the most positive is at the beginning of the list).",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
height: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The height of the item.",
)
model: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The model of the product. Use with the URL of a ProductModel or a textual representation"
"of the model identifier. The URL of the ProductModel can be from an external source. It"
"is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14"
"and mpn properties.",
)
itemCondition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A predefined value from OfferItemCondition specifying the condition of the product"
"or service, or the products or services included in the offer. Also used for product return"
"policies to specify the condition of products accepted for returns.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
nsn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number)"
"(nsn) of a [[Product]].",
)
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.",
)
gtin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin))."
"GTINs identify trade items, including products and services, using numeric identification"
"codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/)"
"express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples"
"can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking"
"issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809)"
"for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN,"
"which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or"
'a "GS1 Digital Link" URL based on such a string. The numeric component should also have'
"a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator)"
"and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for"
"more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]]"
"property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]]"
"properties.Note also that this is a definition for how to include GTINs in Schema.org"
"data, and not a definition of GTINs in general - see the GS1 documentation for authoritative"
"details.",
)
isRelatedTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, somehow related product (or multiple products).",
)
negativeNotes: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Provides negative considerations regarding something, most typically in pro/con"
"lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]],"
"the property describes the [[itemReviewed]] from the perspective of the review; in"
"the case of a [[Product]], the product itself is being described. Since product descriptions"
"tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]]"
"used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used"
"on [[Product]].The property values can be expressed either as unstructured text (repeated"
"as necessary), or if ordered, as a list (in which case the most negative is at the beginning"
"of the list).",
)
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]].",
)
mobileUrl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [[mobileUrl]] property is provided for specific situations in which data consumers"
"need to determine whether one of several provided URLs is a dedicated 'mobile site'.To"
"discourage over-use, and reflecting intial usecases, the property is expected only"
"on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology"
"is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design)"
"in which content can be flexibly adapted to a wide range of browsing environments. Pages"
"and sites referenced with the long-established [[url]] property should ideally also"
"be usable on a wide variety of devices, including mobile phones. In most cases, it would"
"be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]]"
"for more mobile-oriented pages. The property is intended for the case when items (primarily"
'[[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site"'
"alongside the main one. It should not be taken as an endorsement of this publication style.",
)
hasEnergyConsumptionDetails: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description='Defines the energy efficiency Category (also known as "class" or "rating") for'
"a product according to an international energy efficiency standard.",
)
weight: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The weight of the product or person.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
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.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
gtin12: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12"
"is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference,"
"and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
isSimilarTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, functionally similar product (or multiple products).",
)
productID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='The product identifier, such as ISBN. For example: ``` meta itemprop="productID"'
'content="isbn:123-456-789" ```.',
)
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.",
)
hasAdultConsideration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to tag an item to be intended or suitable for consumption or use by adults only.",
)
purchaseDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date the item, e.g. vehicle, was purchased by the current owner.",
)
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.",
)
countryOfLastProcessing: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The place where the item (typically [[Product]]) was last processed and tested before"
"importation.",
)
asin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique"
"identifier assigned by Amazon.com and its partners for product identification within"
"the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s"
"article).Note also that this is a definition for how to include ASINs in Schema.org data,"
"and not a definition of ASINs in general - see documentation from Amazon for authoritative"
"details.ASINs are most commonly encoded as text strings, but the [asin] property supports"
"URL/URI as potential values too.",
)
gtin8: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-8 code of the product, or the product to which the offer refers. This code is also"
"known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
releaseDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The release date of a product or product model. This can be used to distinguish the exact"
"variant of a product.",
)
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.",
)
productionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date of production of the item, e.g. vehicle.",
)
inProductGroupWithID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].",
)
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.",
)
mpn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.",
)
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.",
)
color: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The color of the product.",
)
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.",
)
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.",
)
gtin13: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent"
"to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into"
"a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
sku: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service,"
"or the product to which the offer refers.",
)
isVariantOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the kind of product that this is a variant of. In the case of [[ProductModel]],"
"this is a pointer (from a ProductModel) to a base product from which this product is a variant."
"It is safe to infer that the variant inherits all product features from the base model,"
"unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the"
"group description also serves as a template, representing a set of Products that vary"
"on explicitly defined, specific dimensions only (so it defines both a set of variants,"
"as well as which values distinguish amongst those variants). When used with [[ProductGroup]],"
"this property can apply to any [[Product]] included in the group.",
)
successorOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer from a newer variant of a product to its previous, often discontinued predecessor.",
)
predecessorOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer from a previous, often discontinued variant of the product to its newer variant.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/ProductModel.py
|
ProductModel.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ProductModel(BaseModel):
"""A datasheet or vendor specification of a product (in the sense of a prototypical description).
References:
https://schema.org/ProductModel
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.
hasMeasurement: (Optional[Union[List[Union[str, Any]], str, Any]]): A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.
countryOfAssembly: (Union[List[Union[str, Any]], str, Any]): The place where the product was assembled.
width: (Optional[Union[List[Union[str, Any]], str, Any]]): The width of the item.
isAccessoryOrSparePartFor: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another product (or multiple products) for which this product is an accessory or spare part.
isConsumableFor: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another product (or multiple products) for which this product is a consumable.
depth: (Optional[Union[List[Union[str, Any]], str, Any]]): The depth of the item.
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.
isVariantOf: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group.
slogan: (Union[List[Union[str, Any]], str, Any]): A slogan or motto associated with the item.
manufacturer: (Optional[Union[List[Union[str, Any]], str, Any]]): The manufacturer of the product.
gtin14: (Union[List[Union[str, Any]], str, Any]): The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
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.
positiveNotes: (Union[List[Union[str, Any]], str, Any]): Provides positive considerations regarding something, for example product highlights or (alongside [[negativeNotes]]) pro/con lists for reviews.In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described.The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most positive is at the beginning of the list).
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
height: (Optional[Union[List[Union[str, Any]], str, Any]]): The height of the item.
model: (Union[List[Union[str, Any]], str, Any]): The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties.
itemCondition: (Optional[Union[List[Union[str, Any]], str, Any]]): A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.
award: (Union[List[Union[str, Any]], str, Any]): An award won by or for this item.
nsn: (Union[List[Union[str, Any]], str, Any]): Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [[Product]].
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.
gtin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809) for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.
isRelatedTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, somehow related product (or multiple products).
negativeNotes: (Union[List[Union[str, Any]], str, Any]): Provides negative considerations regarding something, most typically in pro/con lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]], the property describes the [[itemReviewed]] from the perspective of the review; in the case of a [[Product]], the product itself is being described. Since product descriptions tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]] used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used on [[Product]].The property values can be expressed either as unstructured text (repeated as necessary), or if ordered, as a list (in which case the most negative is at the beginning of the list).
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]].
mobileUrl: (Union[List[Union[str, Any]], str, Any]): The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.
hasEnergyConsumptionDetails: (Optional[Union[List[Union[str, Any]], str, Any]]): Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard.
weight: (Optional[Union[List[Union[str, Any]], str, Any]]): The weight of the product or person.
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
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.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
gtin12: (Union[List[Union[str, Any]], str, Any]): The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
isSimilarTo: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to another, functionally similar product (or multiple products).
productID: (Union[List[Union[str, Any]], str, Any]): The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```.
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.
hasAdultConsideration: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to tag an item to be intended or suitable for consumption or use by adults only.
purchaseDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date the item, e.g. vehicle, was purchased by the current owner.
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.
countryOfLastProcessing: (Union[List[Union[str, Any]], str, Any]): The place where the item (typically [[Product]]) was last processed and tested before importation.
asin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s article).Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details.ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.
gtin8: (Union[List[Union[str, Any]], str, Any]): The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
releaseDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The release date of a product or product model. This can be used to distinguish the exact variant of a product.
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.
productionDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date of production of the item, e.g. vehicle.
inProductGroupWithID: (Union[List[Union[str, Any]], str, Any]): Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].
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.
mpn: (Union[List[Union[str, Any]], str, Any]): The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
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.
color: (Union[List[Union[str, Any]], str, Any]): The color of the product.
material: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A material that something is made from, e.g. leather, wool, cotton, paper.
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.
gtin13: (Union[List[Union[str, Any]], str, Any]): The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
sku: (Union[List[Union[str, Any]], str, Any]): The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
isVariantOf: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group.
successorOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer from a newer variant of a product to its previous, often discontinued predecessor.
predecessorOf: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer from a previous, often discontinued variant of the product to its newer variant.
"""
type_: str = Field(default="ProductModel", 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.",
)
hasMeasurement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A product measurement, for example the inseam of pants, the wheel size of a bicycle, or"
"the gauge of a screw. Usually an exact measurement, but can also be a range of measurements"
"for adjustable products, for example belts and ski bindings.",
)
countryOfAssembly: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The place where the product was assembled.",
)
width: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The width of the item.",
)
isAccessoryOrSparePartFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another product (or multiple products) for which this product is an accessory"
"or spare part.",
)
isConsumableFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another product (or multiple products) for which this product is a consumable.",
)
depth: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The depth of the item.",
)
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.",
)
isVariantOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the kind of product that this is a variant of. In the case of [[ProductModel]],"
"this is a pointer (from a ProductModel) to a base product from which this product is a variant."
"It is safe to infer that the variant inherits all product features from the base model,"
"unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the"
"group description also serves as a template, representing a set of Products that vary"
"on explicitly defined, specific dimensions only (so it defines both a set of variants,"
"as well as which values distinguish amongst those variants). When used with [[ProductGroup]],"
"this property can apply to any [[Product]] included in the group.",
)
slogan: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A slogan or motto associated with the item.",
)
manufacturer: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The manufacturer of the product.",
)
gtin14: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN"
"Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.",
)
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.",
)
positiveNotes: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Provides positive considerations regarding something, for example product highlights"
"or (alongside [[negativeNotes]]) pro/con lists for reviews.In the case of a [[Review]],"
"the property describes the [[itemReviewed]] from the perspective of the review; in"
"the case of a [[Product]], the product itself is being described.The property values"
"can be expressed either as unstructured text (repeated as necessary), or if ordered,"
"as a list (in which case the most positive is at the beginning of the list).",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
height: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The height of the item.",
)
model: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The model of the product. Use with the URL of a ProductModel or a textual representation"
"of the model identifier. The URL of the ProductModel can be from an external source. It"
"is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14"
"and mpn properties.",
)
itemCondition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A predefined value from OfferItemCondition specifying the condition of the product"
"or service, or the products or services included in the offer. Also used for product return"
"policies to specify the condition of products accepted for returns.",
)
award: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An award won by or for this item.",
)
nsn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number)"
"(nsn) of a [[Product]].",
)
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.",
)
gtin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin))."
"GTINs identify trade items, including products and services, using numeric identification"
"codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/)"
"express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples"
"can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking"
"issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809)"
"for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN,"
"which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or"
'a "GS1 Digital Link" URL based on such a string. The numeric component should also have'
"a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator)"
"and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for"
"more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]]"
"property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]]"
"properties.Note also that this is a definition for how to include GTINs in Schema.org"
"data, and not a definition of GTINs in general - see the GS1 documentation for authoritative"
"details.",
)
isRelatedTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, somehow related product (or multiple products).",
)
negativeNotes: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Provides negative considerations regarding something, most typically in pro/con"
"lists for reviews (alongside [[positiveNotes]]). For symmetry In the case of a [[Review]],"
"the property describes the [[itemReviewed]] from the perspective of the review; in"
"the case of a [[Product]], the product itself is being described. Since product descriptions"
"tend to emphasise positive claims, it may be relatively unusual to find [[negativeNotes]]"
"used in this way. Nevertheless for the sake of symmetry, [[negativeNotes]] can be used"
"on [[Product]].The property values can be expressed either as unstructured text (repeated"
"as necessary), or if ordered, as a list (in which case the most negative is at the beginning"
"of the list).",
)
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]].",
)
mobileUrl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [[mobileUrl]] property is provided for specific situations in which data consumers"
"need to determine whether one of several provided URLs is a dedicated 'mobile site'.To"
"discourage over-use, and reflecting intial usecases, the property is expected only"
"on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology"
"is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design)"
"in which content can be flexibly adapted to a wide range of browsing environments. Pages"
"and sites referenced with the long-established [[url]] property should ideally also"
"be usable on a wide variety of devices, including mobile phones. In most cases, it would"
"be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]]"
"for more mobile-oriented pages. The property is intended for the case when items (primarily"
'[[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site"'
"alongside the main one. It should not be taken as an endorsement of this publication style.",
)
hasEnergyConsumptionDetails: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description='Defines the energy efficiency Category (also known as "class" or "rating") for'
"a product according to an international energy efficiency standard.",
)
weight: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The weight of the product or person.",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
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.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
gtin12: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12"
"is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference,"
"and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
isSimilarTo: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to another, functionally similar product (or multiple products).",
)
productID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='The product identifier, such as ISBN. For example: ``` meta itemprop="productID"'
'content="isbn:123-456-789" ```.',
)
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.",
)
hasAdultConsideration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to tag an item to be intended or suitable for consumption or use by adults only.",
)
purchaseDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date the item, e.g. vehicle, was purchased by the current owner.",
)
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.",
)
countryOfLastProcessing: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The place where the item (typically [[Product]]) was last processed and tested before"
"importation.",
)
asin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique"
"identifier assigned by Amazon.com and its partners for product identification within"
"the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s"
"article).Note also that this is a definition for how to include ASINs in Schema.org data,"
"and not a definition of ASINs in general - see documentation from Amazon for authoritative"
"details.ASINs are most commonly encoded as text strings, but the [asin] property supports"
"URL/URI as potential values too.",
)
gtin8: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-8 code of the product, or the product to which the offer refers. This code is also"
"known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
releaseDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The release date of a product or product model. This can be used to distinguish the exact"
"variant of a product.",
)
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.",
)
productionDate: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date of production of the item, e.g. vehicle.",
)
inProductGroupWithID: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]].",
)
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.",
)
mpn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.",
)
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.",
)
color: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The color of the product.",
)
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.",
)
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.",
)
gtin13: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent"
"to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into"
"a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
sku: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service,"
"or the product to which the offer refers.",
)
isVariantOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates the kind of product that this is a variant of. In the case of [[ProductModel]],"
"this is a pointer (from a ProductModel) to a base product from which this product is a variant."
"It is safe to infer that the variant inherits all product features from the base model,"
"unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the"
"group description also serves as a template, representing a set of Products that vary"
"on explicitly defined, specific dimensions only (so it defines both a set of variants,"
"as well as which values distinguish amongst those variants). When used with [[ProductGroup]],"
"this property can apply to any [[Product]] included in the group.",
)
successorOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer from a newer variant of a product to its previous, often discontinued predecessor.",
)
predecessorOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer from a previous, often discontinued variant of the product to its newer variant.",
)
| 0.918868 | 0.434581 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalWebPage(BaseModel):
"""A web page that provides medical information.
References:
https://schema.org/MedicalWebPage
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.
medicalAudience: (Optional[Union[List[Union[str, Any]], str, Any]]): Medical audience for page.
aspect: (Union[List[Union[str, Any]], str, Any]): An aspect of medical practice that is considered on the page, such as 'diagnosis', 'treatment', 'causes', 'prognosis', 'etiology', 'epidemiology', etc.
"""
type_: str = Field(default="MedicalWebPage", 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.",
)
medicalAudience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Medical audience for page.",
)
aspect: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An aspect of medical practice that is considered on the page, such as 'diagnosis', 'treatment',"
"'causes', 'prognosis', 'etiology', 'epidemiology', etc.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MedicalWebPage.py
|
MedicalWebPage.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalWebPage(BaseModel):
"""A web page that provides medical information.
References:
https://schema.org/MedicalWebPage
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.
medicalAudience: (Optional[Union[List[Union[str, Any]], str, Any]]): Medical audience for page.
aspect: (Union[List[Union[str, Any]], str, Any]): An aspect of medical practice that is considered on the page, such as 'diagnosis', 'treatment', 'causes', 'prognosis', 'etiology', 'epidemiology', etc.
"""
type_: str = Field(default="MedicalWebPage", 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.",
)
medicalAudience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Medical audience for page.",
)
aspect: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="An aspect of medical practice that is considered on the page, such as 'diagnosis', 'treatment',"
"'causes', 'prognosis', 'etiology', 'epidemiology', etc.",
)
| 0.923364 | 0.329958 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DigitalPlatformEnumeration(BaseModel):
"""Enumerates some common technology platforms, for use with properties such as [[actionPlatform]]. It is not supposed to be comprehensive - when a suitable code is not enumerated here, textual or URL values can be used instead. These codes are at a fairly high level and do not deal with versioning and other nuance. Additional codes can be suggested [in github](https://github.com/schemaorg/schemaorg/issues/3057).
References:
https://schema.org/DigitalPlatformEnumeration
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="DigitalPlatformEnumeration", 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/DigitalPlatformEnumeration.py
|
DigitalPlatformEnumeration.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DigitalPlatformEnumeration(BaseModel):
"""Enumerates some common technology platforms, for use with properties such as [[actionPlatform]]. It is not supposed to be comprehensive - when a suitable code is not enumerated here, textual or URL values can be used instead. These codes are at a fairly high level and do not deal with versioning and other nuance. Additional codes can be suggested [in github](https://github.com/schemaorg/schemaorg/issues/3057).
References:
https://schema.org/DigitalPlatformEnumeration
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="DigitalPlatformEnumeration", 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.94304 | 0.370225 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class FundingScheme(BaseModel):
"""A FundingScheme combines organizational, project and policy aspects of grant-based funding that sets guidelines, principles and mechanisms to support other kinds of projects and activities. Funding is typically organized via [[Grant]] funding. Examples of funding schemes: Swiss Priority Programmes (SPPs); EU Framework 7 (FP7); Horizon 2020; the NIH-R01 Grant Program; Wellcome institutional strategic support fund. For large scale public sector funding, the management and administration of grant awards is often handled by other, dedicated, organizations - [[FundingAgency]]s such as ERC, REA, ...
References:
https://schema.org/FundingScheme
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="FundingScheme", 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/FundingScheme.py
|
FundingScheme.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class FundingScheme(BaseModel):
"""A FundingScheme combines organizational, project and policy aspects of grant-based funding that sets guidelines, principles and mechanisms to support other kinds of projects and activities. Funding is typically organized via [[Grant]] funding. Examples of funding schemes: Swiss Priority Programmes (SPPs); EU Framework 7 (FP7); Horizon 2020; the NIH-R01 Grant Program; Wellcome institutional strategic support fund. For large scale public sector funding, the management and administration of grant awards is often handled by other, dedicated, organizations - [[FundingAgency]]s such as ERC, REA, ...
References:
https://schema.org/FundingScheme
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="FundingScheme", 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.892448 | 0.410874 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class RadioBroadcastService(BaseModel):
"""A delivery service through which radio content is provided via broadcast over the air or online.
References:
https://schema.org/RadioBroadcastService
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.
hasBroadcastChannel: (Optional[Union[List[Union[str, Any]], str, Any]]): A broadcast channel of a broadcast service.
parentService: (Optional[Union[List[Union[str, Any]], str, Any]]): A broadcast service to which the broadcast service may belong to such as regional variations of a national channel.
broadcastAffiliateOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The media network(s) whose content is broadcast on this station.
broadcaster: (Optional[Union[List[Union[str, Any]], str, Any]]): The organization owning or operating the broadcast service.
videoFormat: (Union[List[Union[str, Any]], str, Any]): The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.).
broadcastTimezone: (Union[List[Union[str, Any]], str, Any]): The timezone in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) for which the service bases its broadcasts.
broadcastDisplayName: (Union[List[Union[str, Any]], str, Any]): The name displayed in the channel guide. For many US affiliates, it is the network name.
broadcastFrequency: (Union[List[Union[str, Any]], str, Any]): The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. "87 FM".
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]].
area: (Optional[Union[List[Union[str, Any]], str, Any]]): The area within which users can expect to reach the broadcast service.
callSign: (Union[List[Union[str, Any]], str, Any]): A [callsign](https://en.wikipedia.org/wiki/Call_sign), as used in broadcasting and radio communications to identify people, radio and TV stations, or vehicles.
"""
type_: str = Field(default="RadioBroadcastService", 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.",
)
hasBroadcastChannel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A broadcast channel of a broadcast service.",
)
parentService: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A broadcast service to which the broadcast service may belong to such as regional variations"
"of a national channel.",
)
broadcastAffiliateOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The media network(s) whose content is broadcast on this station.",
)
broadcaster: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The organization owning or operating the broadcast service.",
)
videoFormat: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.).",
)
broadcastTimezone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The timezone in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) for which"
"the service bases its broadcasts.",
)
broadcastDisplayName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name displayed in the channel guide. For many US affiliates, it is the network name.",
)
broadcastFrequency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g."
"87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels,"
'e.g. "87 FM".',
)
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]].",
)
area: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The area within which users can expect to reach the broadcast service.",
)
callSign: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A [callsign](https://en.wikipedia.org/wiki/Call_sign), as used in broadcasting"
"and radio communications to identify people, radio and TV stations, or vehicles.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/RadioBroadcastService.py
|
RadioBroadcastService.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class RadioBroadcastService(BaseModel):
"""A delivery service through which radio content is provided via broadcast over the air or online.
References:
https://schema.org/RadioBroadcastService
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.
hasBroadcastChannel: (Optional[Union[List[Union[str, Any]], str, Any]]): A broadcast channel of a broadcast service.
parentService: (Optional[Union[List[Union[str, Any]], str, Any]]): A broadcast service to which the broadcast service may belong to such as regional variations of a national channel.
broadcastAffiliateOf: (Optional[Union[List[Union[str, Any]], str, Any]]): The media network(s) whose content is broadcast on this station.
broadcaster: (Optional[Union[List[Union[str, Any]], str, Any]]): The organization owning or operating the broadcast service.
videoFormat: (Union[List[Union[str, Any]], str, Any]): The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.).
broadcastTimezone: (Union[List[Union[str, Any]], str, Any]): The timezone in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) for which the service bases its broadcasts.
broadcastDisplayName: (Union[List[Union[str, Any]], str, Any]): The name displayed in the channel guide. For many US affiliates, it is the network name.
broadcastFrequency: (Union[List[Union[str, Any]], str, Any]): The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g. 87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels, e.g. "87 FM".
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]].
area: (Optional[Union[List[Union[str, Any]], str, Any]]): The area within which users can expect to reach the broadcast service.
callSign: (Union[List[Union[str, Any]], str, Any]): A [callsign](https://en.wikipedia.org/wiki/Call_sign), as used in broadcasting and radio communications to identify people, radio and TV stations, or vehicles.
"""
type_: str = Field(default="RadioBroadcastService", 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.",
)
hasBroadcastChannel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A broadcast channel of a broadcast service.",
)
parentService: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A broadcast service to which the broadcast service may belong to such as regional variations"
"of a national channel.",
)
broadcastAffiliateOf: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The media network(s) whose content is broadcast on this station.",
)
broadcaster: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The organization owning or operating the broadcast service.",
)
videoFormat: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.).",
)
broadcastTimezone: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The timezone in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601) for which"
"the service bases its broadcasts.",
)
broadcastDisplayName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name displayed in the channel guide. For many US affiliates, it is the network name.",
)
broadcastFrequency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The frequency used for over-the-air broadcasts. Numeric values or simple ranges, e.g."
"87-99. In addition a shortcut idiom is supported for frequences of AM and FM radio channels,"
'e.g. "87 FM".',
)
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]].",
)
area: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The area within which users can expect to reach the broadcast service.",
)
callSign: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A [callsign](https://en.wikipedia.org/wiki/Call_sign), as used in broadcasting"
"and radio communications to identify people, radio and TV stations, or vehicles.",
)
| 0.899282 | 0.346099 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ServiceChannel(BaseModel):
"""A means for accessing a service, e.g. a government office location, web site, or phone number.
References:
https://schema.org/ServiceChannel
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.
servicePhone: (Optional[Union[List[Union[str, Any]], str, Any]]): The phone number to use to access the service.
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]].
serviceUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The website to access the service.
processingTime: (Optional[Union[List[Union[str, Any]], str, Any]]): Estimated processing time for the service using this channel.
servicePostalAddress: (Optional[Union[List[Union[str, Any]], str, Any]]): The address for accessing the service by mail.
providesService: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provided by this channel.
serviceSmsNumber: (Optional[Union[List[Union[str, Any]], str, Any]]): The number to access the service by text message.
serviceLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location (e.g. civic structure, local business, etc.) where a person can go to access the service.
"""
type_: str = Field(default="ServiceChannel", 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.",
)
servicePhone: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The phone number to use to access the service.",
)
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]].",
)
serviceUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The website to access the service.",
)
processingTime: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Estimated processing time for the service using this channel.",
)
servicePostalAddress: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The address for accessing the service by mail.",
)
providesService: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provided by this channel.",
)
serviceSmsNumber: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number to access the service by text message.",
)
serviceLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location (e.g. civic structure, local business, etc.) where a person can go to access"
"the service.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/ServiceChannel.py
|
ServiceChannel.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ServiceChannel(BaseModel):
"""A means for accessing a service, e.g. a government office location, web site, or phone number.
References:
https://schema.org/ServiceChannel
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.
servicePhone: (Optional[Union[List[Union[str, Any]], str, Any]]): The phone number to use to access the service.
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]].
serviceUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The website to access the service.
processingTime: (Optional[Union[List[Union[str, Any]], str, Any]]): Estimated processing time for the service using this channel.
servicePostalAddress: (Optional[Union[List[Union[str, Any]], str, Any]]): The address for accessing the service by mail.
providesService: (Optional[Union[List[Union[str, Any]], str, Any]]): The service provided by this channel.
serviceSmsNumber: (Optional[Union[List[Union[str, Any]], str, Any]]): The number to access the service by text message.
serviceLocation: (Optional[Union[List[Union[str, Any]], str, Any]]): The location (e.g. civic structure, local business, etc.) where a person can go to access the service.
"""
type_: str = Field(default="ServiceChannel", 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.",
)
servicePhone: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The phone number to use to access the service.",
)
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]].",
)
serviceUrl: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="The website to access the service.",
)
processingTime: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Estimated processing time for the service using this channel.",
)
servicePostalAddress: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The address for accessing the service by mail.",
)
providesService: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service provided by this channel.",
)
serviceSmsNumber: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The number to access the service by text message.",
)
serviceLocation: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The location (e.g. civic structure, local business, etc.) where a person can go to access"
"the service.",
)
| 0.936394 | 0.323514 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SubwayStation(BaseModel):
"""A subway station.
References:
https://schema.org/SubwayStation
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).
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="SubwayStation", 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>.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/SubwayStation.py
|
SubwayStation.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SubwayStation(BaseModel):
"""A subway station.
References:
https://schema.org/SubwayStation
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).
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="SubwayStation", 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>.",
)
| 0.936292 | 0.535766 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class AudioObjectSnapshot(BaseModel):
"""A specific and exact (byte-for-byte) version of an [[AudioObject]]. Two byte-for-byte identical files, for the purposes of this type, considered identical. If they have different embedded metadata the files will differ. Different external facts about the files, e.g. creator or dateCreated that aren't represented in their actual content, do not affect this notion of identity.
References:
https://schema.org/AudioObjectSnapshot
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.
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.
caption: (Union[List[Union[str, Any]], str, Any]): The caption for this object. For downloadable machine formats (closed caption, subtitles etc.) use MediaObject and indicate the [[encodingFormat]].
embeddedTextCaption: (Union[List[Union[str, Any]], str, Any]): Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'.
transcript: (Union[List[Union[str, Any]], str, Any]): If this MediaObject is an AudioObject or VideoObject, the transcript of that object.
"""
type_: str = Field(default="AudioObjectSnapshot", 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.",
)
caption: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The caption for this object. For downloadable machine formats (closed caption, subtitles"
"etc.) use MediaObject and indicate the [[encodingFormat]].",
)
embeddedTextCaption: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'.",
)
transcript: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="If this MediaObject is an AudioObject or VideoObject, the transcript of that object.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/AudioObjectSnapshot.py
|
AudioObjectSnapshot.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class AudioObjectSnapshot(BaseModel):
"""A specific and exact (byte-for-byte) version of an [[AudioObject]]. Two byte-for-byte identical files, for the purposes of this type, considered identical. If they have different embedded metadata the files will differ. Different external facts about the files, e.g. creator or dateCreated that aren't represented in their actual content, do not affect this notion of identity.
References:
https://schema.org/AudioObjectSnapshot
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.
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.
caption: (Union[List[Union[str, Any]], str, Any]): The caption for this object. For downloadable machine formats (closed caption, subtitles etc.) use MediaObject and indicate the [[encodingFormat]].
embeddedTextCaption: (Union[List[Union[str, Any]], str, Any]): Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'.
transcript: (Union[List[Union[str, Any]], str, Any]): If this MediaObject is an AudioObject or VideoObject, the transcript of that object.
"""
type_: str = Field(default="AudioObjectSnapshot", 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.",
)
caption: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The caption for this object. For downloadable machine formats (closed caption, subtitles"
"etc.) use MediaObject and indicate the [[encodingFormat]].",
)
embeddedTextCaption: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Represents textual captioning from a [[MediaObject]], e.g. text of a 'meme'.",
)
transcript: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="If this MediaObject is an AudioObject or VideoObject, the transcript of that object.",
)
| 0.926087 | 0.358578 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class AlignmentObject(BaseModel):
"""An intangible item that describes an alignment between a learning resource and a node in an educational framework.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.
References:
https://schema.org/AlignmentObject
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.
targetName: (Union[List[Union[str, Any]], str, Any]): The name of a node in an established educational framework.
targetUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The URL of a node in an established educational framework.
alignmentType: (Union[List[Union[str, Any]], str, Any]): A category of alignment between the learning resource and the framework node. Recommended values include: 'requires', 'textComplexity', 'readingLevel', and 'educationalSubject'.
targetDescription: (Union[List[Union[str, Any]], str, Any]): The description of a node in an established educational framework.
educationalFramework: (Union[List[Union[str, Any]], str, Any]): The framework to which the resource being described is aligned.
"""
type_: str = Field(default="AlignmentObject", 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.",
)
targetName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of a node in an established educational framework.",
)
targetUrl: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The URL of a node in an established educational framework.",
)
alignmentType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A category of alignment between the learning resource and the framework node. Recommended"
"values include: 'requires', 'textComplexity', 'readingLevel', and 'educationalSubject'.",
)
targetDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The description of a node in an established educational framework.",
)
educationalFramework: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The framework to which the resource being described is aligned.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/AlignmentObject.py
|
AlignmentObject.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class AlignmentObject(BaseModel):
"""An intangible item that describes an alignment between a learning resource and a node in an educational framework.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.
References:
https://schema.org/AlignmentObject
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.
targetName: (Union[List[Union[str, Any]], str, Any]): The name of a node in an established educational framework.
targetUrl: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): The URL of a node in an established educational framework.
alignmentType: (Union[List[Union[str, Any]], str, Any]): A category of alignment between the learning resource and the framework node. Recommended values include: 'requires', 'textComplexity', 'readingLevel', and 'educationalSubject'.
targetDescription: (Union[List[Union[str, Any]], str, Any]): The description of a node in an established educational framework.
educationalFramework: (Union[List[Union[str, Any]], str, Any]): The framework to which the resource being described is aligned.
"""
type_: str = Field(default="AlignmentObject", 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.",
)
targetName: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The name of a node in an established educational framework.",
)
targetUrl: Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]] = Field(
default=None,
description="The URL of a node in an established educational framework.",
)
alignmentType: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A category of alignment between the learning resource and the framework node. Recommended"
"values include: 'requires', 'textComplexity', 'readingLevel', and 'educationalSubject'.",
)
targetDescription: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The description of a node in an established educational framework.",
)
educationalFramework: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The framework to which the resource being described is aligned.",
)
| 0.945976 | 0.449091 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BodyMeasurementWaist(BaseModel):
"""Girth of natural waistline (between hip bones and lower ribs). Used, for example, to fit pants.
References:
https://schema.org/BodyMeasurementWaist
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="BodyMeasurementWaist", 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/BodyMeasurementWaist.py
|
BodyMeasurementWaist.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BodyMeasurementWaist(BaseModel):
"""Girth of natural waistline (between hip bones and lower ribs). Used, for example, to fit pants.
References:
https://schema.org/BodyMeasurementWaist
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="BodyMeasurementWaist", 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.945914 | 0.367015 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CableOrSatelliteService(BaseModel):
"""A service which provides access to media programming like TV or radio. Access may be via cable or satellite.
References:
https://schema.org/CableOrSatelliteService
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.
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.
"""
type_: str = Field(default="CableOrSatelliteService", 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.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/CableOrSatelliteService.py
|
CableOrSatelliteService.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CableOrSatelliteService(BaseModel):
"""A service which provides access to media programming like TV or radio. Access may be via cable or satellite.
References:
https://schema.org/CableOrSatelliteService
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.
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.
"""
type_: str = Field(default="CableOrSatelliteService", 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.",
)
| 0.907692 | 0.397061 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MapCategoryType(BaseModel):
"""An enumeration of several kinds of Map.
References:
https://schema.org/MapCategoryType
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="MapCategoryType", 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/MapCategoryType.py
|
MapCategoryType.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MapCategoryType(BaseModel):
"""An enumeration of several kinds of Map.
References:
https://schema.org/MapCategoryType
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="MapCategoryType", 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.940701 | 0.328987 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c9(BaseModel):
"""Nonprofit501c9: Non-profit type referring to Voluntary Employee Beneficiary Associations.
References:
https://schema.org/Nonprofit501c9
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="Nonprofit501c9", 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/Nonprofit501c9.py
|
Nonprofit501c9.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c9(BaseModel):
"""Nonprofit501c9: Non-profit type referring to Voluntary Employee Beneficiary Associations.
References:
https://schema.org/Nonprofit501c9
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="Nonprofit501c9", 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.944382 | 0.27455 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CaseSeries(BaseModel):
"""A case series (also known as a clinical series) is a medical research study that tracks patients with a known exposure given similar treatment or examines their medical records for exposure and outcome. A case series can be retrospective or prospective and usually involves a smaller number of patients than the more powerful case-control studies or randomized controlled trials. Case series may be consecutive or non-consecutive, depending on whether all cases presenting to the reporting authors over a period of time were included, or only a selection.
References:
https://schema.org/CaseSeries
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="CaseSeries", 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/CaseSeries.py
|
CaseSeries.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CaseSeries(BaseModel):
"""A case series (also known as a clinical series) is a medical research study that tracks patients with a known exposure given similar treatment or examines their medical records for exposure and outcome. A case series can be retrospective or prospective and usually involves a smaller number of patients than the more powerful case-control studies or randomized controlled trials. Case series may be consecutive or non-consecutive, depending on whether all cases presenting to the reporting authors over a period of time were included, or only a selection.
References:
https://schema.org/CaseSeries
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="CaseSeries", 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.952209 | 0.482673 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DrugCostCategory(BaseModel):
"""Enumerated categories of medical drug costs.
References:
https://schema.org/DrugCostCategory
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="DrugCostCategory", 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/DrugCostCategory.py
|
DrugCostCategory.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DrugCostCategory(BaseModel):
"""Enumerated categories of medical drug costs.
References:
https://schema.org/DrugCostCategory
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="DrugCostCategory", 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.945286 | 0.324543 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BreadcrumbList(BaseModel):
"""A BreadcrumbList is an ItemList consisting of a chain of linked Web pages, typically described using at least their URL and their name, and typically ending with the current page.The [[position]] property is used to reconstruct the order of the items in a BreadcrumbList. The convention is that a breadcrumb list has an [[itemListOrder]] of [[ItemListOrderAscending]] (lower values listed first), and that the first items in this list correspond to the "top" or beginning of the breadcrumb trail, e.g. with a site or section homepage. The specific values of 'position' are not assigned meaning for a BreadcrumbList, but they should be integers, e.g. beginning with '1' for the first item in the list.
References:
https://schema.org/BreadcrumbList
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.
itemListOrder: (Union[List[Union[str, Any]], str, Any]): Type of ordering (e.g. Ascending, Descending, Unordered).
numberOfItems: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list.
itemListElement: (Union[List[Union[str, Any]], str, Any]): For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.Text values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.Note: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases.
"""
type_: str = Field(default="BreadcrumbList", 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.",
)
itemListOrder: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Type of ordering (e.g. Ascending, Descending, Unordered).",
)
numberOfItems: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of items in an ItemList. Note that some descriptions might not fully describe"
"all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems"
"would be for the entire list.",
)
itemListElement: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='For itemListElement values, you can use simple strings (e.g. "Peter", "Paul",'
'"Mary"), existing entities, or use ListItem.Text values are best if the elements'
"in the list are plain strings. Existing entities are best for a simple, unordered list"
"of existing things in your data. ListItem is used with ordered lists when you want to provide"
"additional context about the element in that list or when the same item might be in different"
"places in different lists.Note: The order of elements in your mark-up is not sufficient"
"for indicating the order or elements. Use ListItem with a 'position' property in such"
"cases.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/BreadcrumbList.py
|
BreadcrumbList.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BreadcrumbList(BaseModel):
"""A BreadcrumbList is an ItemList consisting of a chain of linked Web pages, typically described using at least their URL and their name, and typically ending with the current page.The [[position]] property is used to reconstruct the order of the items in a BreadcrumbList. The convention is that a breadcrumb list has an [[itemListOrder]] of [[ItemListOrderAscending]] (lower values listed first), and that the first items in this list correspond to the "top" or beginning of the breadcrumb trail, e.g. with a site or section homepage. The specific values of 'position' are not assigned meaning for a BreadcrumbList, but they should be integers, e.g. beginning with '1' for the first item in the list.
References:
https://schema.org/BreadcrumbList
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.
itemListOrder: (Union[List[Union[str, Any]], str, Any]): Type of ordering (e.g. Ascending, Descending, Unordered).
numberOfItems: (Optional[Union[List[Union[str, int, Any]], str, int, Any]]): The number of items in an ItemList. Note that some descriptions might not fully describe all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems would be for the entire list.
itemListElement: (Union[List[Union[str, Any]], str, Any]): For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.Text values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists.Note: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases.
"""
type_: str = Field(default="BreadcrumbList", 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.",
)
itemListOrder: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Type of ordering (e.g. Ascending, Descending, Unordered).",
)
numberOfItems: Optional[Union[List[Union[str, int, Any]], str, int, Any]] = Field(
default=None,
description="The number of items in an ItemList. Note that some descriptions might not fully describe"
"all items in a list (e.g., multi-page pagination); in such cases, the numberOfItems"
"would be for the entire list.",
)
itemListElement: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description='For itemListElement values, you can use simple strings (e.g. "Peter", "Paul",'
'"Mary"), existing entities, or use ListItem.Text values are best if the elements'
"in the list are plain strings. Existing entities are best for a simple, unordered list"
"of existing things in your data. ListItem is used with ordered lists when you want to provide"
"additional context about the element in that list or when the same item might be in different"
"places in different lists.Note: The order of elements in your mark-up is not sufficient"
"for indicating the order or elements. Use ListItem with a 'position' property in such"
"cases.",
)
| 0.935729 | 0.457197 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DefinedTerm(BaseModel):
"""A word, name, acronym, phrase, etc. with a formal definition. Often used in the context of category or subject classification, glossaries or dictionaries, product or creative work types, etc. Use the name property for the term being defined, use termCode if the term has an alpha-numeric code allocated, use description to provide the definition of the term.
References:
https://schema.org/DefinedTerm
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.
inDefinedTermSet: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A [[DefinedTermSet]] that contains this term.
termCode: (Union[List[Union[str, Any]], str, Any]): A code that identifies this [[DefinedTerm]] within a [[DefinedTermSet]]
"""
type_: str = Field(default="DefinedTerm", 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.",
)
inDefinedTermSet: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A [[DefinedTermSet]] that contains this term.",
)
termCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A code that identifies this [[DefinedTerm]] within a [[DefinedTermSet]]",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/DefinedTerm.py
|
DefinedTerm.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DefinedTerm(BaseModel):
"""A word, name, acronym, phrase, etc. with a formal definition. Often used in the context of category or subject classification, glossaries or dictionaries, product or creative work types, etc. Use the name property for the term being defined, use termCode if the term has an alpha-numeric code allocated, use description to provide the definition of the term.
References:
https://schema.org/DefinedTerm
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.
inDefinedTermSet: (Optional[Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]]): A [[DefinedTermSet]] that contains this term.
termCode: (Union[List[Union[str, Any]], str, Any]): A code that identifies this [[DefinedTerm]] within a [[DefinedTermSet]]
"""
type_: str = Field(default="DefinedTerm", 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.",
)
inDefinedTermSet: Optional[
Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]
] = Field(
default=None,
description="A [[DefinedTermSet]] that contains this term.",
)
termCode: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A code that identifies this [[DefinedTerm]] within a [[DefinedTermSet]]",
)
| 0.926873 | 0.369543 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OccupationalTherapy(BaseModel):
"""A treatment of people with physical, emotional, or social problems, using purposeful activity to help them overcome or learn to deal with their problems.
References:
https://schema.org/OccupationalTherapy
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.
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.
doseSchedule: (Optional[Union[List[Union[str, Any]], str, Any]]): A dosing schedule for the drug for a given population, either observed, recommended, or maximum dose based on the type used.
drug: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifying a drug or medicine used in a medication procedure.
adverseOutcome: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible complication and/or side effect of this therapy. If it is known that an adverse outcome is serious (resulting in death, disability, or permanent damage; requiring hospitalization; or otherwise life-threatening or requiring immediate medical attention), tag it as a seriousAdverseOutcome instead.
seriousAdverseOutcome: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible serious complication and/or serious side effect of this therapy. Serious adverse outcomes include those that are life-threatening; result in death, disability, or permanent damage; require hospitalization or prolong existing hospitalization; cause congenital anomalies or birth defects; or jeopardize the patient and may require medical or surgical intervention to prevent one of the outcomes in this definition.
duplicateTherapy: (Optional[Union[List[Union[str, Any]], str, Any]]): A therapy that duplicates or overlaps this one.
contraindication: (Union[List[Union[str, Any]], str, Any]): A contraindication for this therapy.
"""
type_: str = Field(default="OccupationalTherapy", 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.",
)
doseSchedule: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A dosing schedule for the drug for a given population, either observed, recommended,"
"or maximum dose based on the type used.",
)
drug: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifying a drug or medicine used in a medication procedure.",
)
adverseOutcome: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible complication and/or side effect of this therapy. If it is known that an adverse"
"outcome is serious (resulting in death, disability, or permanent damage; requiring"
"hospitalization; or otherwise life-threatening or requiring immediate medical attention),"
"tag it as a seriousAdverseOutcome instead.",
)
seriousAdverseOutcome: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible serious complication and/or serious side effect of this therapy. Serious"
"adverse outcomes include those that are life-threatening; result in death, disability,"
"or permanent damage; require hospitalization or prolong existing hospitalization;"
"cause congenital anomalies or birth defects; or jeopardize the patient and may require"
"medical or surgical intervention to prevent one of the outcomes in this definition.",
)
duplicateTherapy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A therapy that duplicates or overlaps this one.",
)
contraindication: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A contraindication for this therapy.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/OccupationalTherapy.py
|
OccupationalTherapy.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OccupationalTherapy(BaseModel):
"""A treatment of people with physical, emotional, or social problems, using purposeful activity to help them overcome or learn to deal with their problems.
References:
https://schema.org/OccupationalTherapy
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.
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.
doseSchedule: (Optional[Union[List[Union[str, Any]], str, Any]]): A dosing schedule for the drug for a given population, either observed, recommended, or maximum dose based on the type used.
drug: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifying a drug or medicine used in a medication procedure.
adverseOutcome: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible complication and/or side effect of this therapy. If it is known that an adverse outcome is serious (resulting in death, disability, or permanent damage; requiring hospitalization; or otherwise life-threatening or requiring immediate medical attention), tag it as a seriousAdverseOutcome instead.
seriousAdverseOutcome: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible serious complication and/or serious side effect of this therapy. Serious adverse outcomes include those that are life-threatening; result in death, disability, or permanent damage; require hospitalization or prolong existing hospitalization; cause congenital anomalies or birth defects; or jeopardize the patient and may require medical or surgical intervention to prevent one of the outcomes in this definition.
duplicateTherapy: (Optional[Union[List[Union[str, Any]], str, Any]]): A therapy that duplicates or overlaps this one.
contraindication: (Union[List[Union[str, Any]], str, Any]): A contraindication for this therapy.
"""
type_: str = Field(default="OccupationalTherapy", 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.",
)
doseSchedule: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A dosing schedule for the drug for a given population, either observed, recommended,"
"or maximum dose based on the type used.",
)
drug: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifying a drug or medicine used in a medication procedure.",
)
adverseOutcome: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible complication and/or side effect of this therapy. If it is known that an adverse"
"outcome is serious (resulting in death, disability, or permanent damage; requiring"
"hospitalization; or otherwise life-threatening or requiring immediate medical attention),"
"tag it as a seriousAdverseOutcome instead.",
)
seriousAdverseOutcome: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible serious complication and/or serious side effect of this therapy. Serious"
"adverse outcomes include those that are life-threatening; result in death, disability,"
"or permanent damage; require hospitalization or prolong existing hospitalization;"
"cause congenital anomalies or birth defects; or jeopardize the patient and may require"
"medical or surgical intervention to prevent one of the outcomes in this definition.",
)
duplicateTherapy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A therapy that duplicates or overlaps this one.",
)
contraindication: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A contraindication for this therapy.",
)
| 0.979111 | 0.393618 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalGuidelineContraindication(BaseModel):
"""A guideline contraindication that designates a process as harmful and where quality of the data supporting the contraindication is sound.
References:
https://schema.org/MedicalGuidelineContraindication
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.
evidenceLevel: (Optional[Union[List[Union[str, Any]], str, Any]]): Strength of evidence of the data used to formulate the guideline (enumerated).
guidelineSubject: (Optional[Union[List[Union[str, Any]], str, Any]]): The medical conditions, treatments, etc. that are the subject of the guideline.
guidelineDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Date on which this guideline's recommendation was made.
evidenceOrigin: (Union[List[Union[str, Any]], str, Any]): Source of the data used to formulate the guidance, e.g. RCT, consensus opinion, etc.
"""
type_: str = Field(
default="MedicalGuidelineContraindication", 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.",
)
evidenceLevel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Strength of evidence of the data used to formulate the guideline (enumerated).",
)
guidelineSubject: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The medical conditions, treatments, etc. that are the subject of the guideline.",
)
guidelineDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="Date on which this guideline's recommendation was made.",
)
evidenceOrigin: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Source of the data used to formulate the guidance, e.g. RCT, consensus opinion, etc.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MedicalGuidelineContraindication.py
|
MedicalGuidelineContraindication.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalGuidelineContraindication(BaseModel):
"""A guideline contraindication that designates a process as harmful and where quality of the data supporting the contraindication is sound.
References:
https://schema.org/MedicalGuidelineContraindication
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.
evidenceLevel: (Optional[Union[List[Union[str, Any]], str, Any]]): Strength of evidence of the data used to formulate the guideline (enumerated).
guidelineSubject: (Optional[Union[List[Union[str, Any]], str, Any]]): The medical conditions, treatments, etc. that are the subject of the guideline.
guidelineDate: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): Date on which this guideline's recommendation was made.
evidenceOrigin: (Union[List[Union[str, Any]], str, Any]): Source of the data used to formulate the guidance, e.g. RCT, consensus opinion, etc.
"""
type_: str = Field(
default="MedicalGuidelineContraindication", 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.",
)
evidenceLevel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Strength of evidence of the data used to formulate the guideline (enumerated).",
)
guidelineSubject: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The medical conditions, treatments, etc. that are the subject of the guideline.",
)
guidelineDate: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="Date on which this guideline's recommendation was made.",
)
evidenceOrigin: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Source of the data used to formulate the guidance, e.g. RCT, consensus opinion, etc.",
)
| 0.929103 | 0.336535 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Diet(BaseModel):
"""A strategy of regulating the intake of food to achieve or maintain a specific health-related goal.
References:
https://schema.org/Diet
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.
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.
endorsers: (Optional[Union[List[Union[str, Any]], str, Any]]): People or organizations that endorse the plan.
dietFeatures: (Union[List[Union[str, Any]], str, Any]): Nutritional information specific to the dietary plan. May include dietary recommendations on what foods to avoid, what foods to consume, and specific alterations/deviations from the USDA or other regulatory body's approved dietary guidelines.
physiologicalBenefits: (Union[List[Union[str, Any]], str, Any]): Specific physiologic benefits associated to the plan.
expertConsiderations: (Union[List[Union[str, Any]], str, Any]): Medical expert advice related to the plan.
risks: (Union[List[Union[str, Any]], str, Any]): Specific physiologic risks associated to the diet plan.
"""
type_: str = Field(default="Diet", 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.",
)
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.",
)
endorsers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People or organizations that endorse the plan.",
)
dietFeatures: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Nutritional information specific to the dietary plan. May include dietary recommendations"
"on what foods to avoid, what foods to consume, and specific alterations/deviations"
"from the USDA or other regulatory body's approved dietary guidelines.",
)
physiologicalBenefits: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Specific physiologic benefits associated to the plan.",
)
expertConsiderations: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Medical expert advice related to the plan.",
)
risks: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Specific physiologic risks associated to the diet plan.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Diet.py
|
Diet.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Diet(BaseModel):
"""A strategy of regulating the intake of food to achieve or maintain a specific health-related goal.
References:
https://schema.org/Diet
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.
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.
endorsers: (Optional[Union[List[Union[str, Any]], str, Any]]): People or organizations that endorse the plan.
dietFeatures: (Union[List[Union[str, Any]], str, Any]): Nutritional information specific to the dietary plan. May include dietary recommendations on what foods to avoid, what foods to consume, and specific alterations/deviations from the USDA or other regulatory body's approved dietary guidelines.
physiologicalBenefits: (Union[List[Union[str, Any]], str, Any]): Specific physiologic benefits associated to the plan.
expertConsiderations: (Union[List[Union[str, Any]], str, Any]): Medical expert advice related to the plan.
risks: (Union[List[Union[str, Any]], str, Any]): Specific physiologic risks associated to the diet plan.
"""
type_: str = Field(default="Diet", 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.",
)
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.",
)
endorsers: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="People or organizations that endorse the plan.",
)
dietFeatures: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Nutritional information specific to the dietary plan. May include dietary recommendations"
"on what foods to avoid, what foods to consume, and specific alterations/deviations"
"from the USDA or other regulatory body's approved dietary guidelines.",
)
physiologicalBenefits: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Specific physiologic benefits associated to the plan.",
)
expertConsiderations: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Medical expert advice related to the plan.",
)
risks: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Specific physiologic risks associated to the diet plan.",
)
| 0.899965 | 0.375592 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DVDFormat(BaseModel):
"""DVDFormat.
References:
https://schema.org/DVDFormat
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="DVDFormat", 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/DVDFormat.py
|
DVDFormat.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DVDFormat(BaseModel):
"""DVDFormat.
References:
https://schema.org/DVDFormat
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="DVDFormat", 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.940182 | 0.316541 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class RandomizedTrial(BaseModel):
"""A randomized trial design.
References:
https://schema.org/RandomizedTrial
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="RandomizedTrial", 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/RandomizedTrial.py
|
RandomizedTrial.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class RandomizedTrial(BaseModel):
"""A randomized trial design.
References:
https://schema.org/RandomizedTrial
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="RandomizedTrial", 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.938667 | 0.30935 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ReservationHold(BaseModel):
"""The status of a reservation on hold pending an update like credit card number or flight changes.
References:
https://schema.org/ReservationHold
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="ReservationHold", 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/ReservationHold.py
|
ReservationHold.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ReservationHold(BaseModel):
"""The status of a reservation on hold pending an update like credit card number or flight changes.
References:
https://schema.org/ReservationHold
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="ReservationHold", 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.944536 | 0.323233 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BookFormatType(BaseModel):
"""The publication format of the book.
References:
https://schema.org/BookFormatType
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="BookFormatType", 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/BookFormatType.py
|
BookFormatType.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BookFormatType(BaseModel):
"""The publication format of the book.
References:
https://schema.org/BookFormatType
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="BookFormatType", 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.942869 | 0.342324 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BroadcastFrequencySpecification(BaseModel):
"""The frequency in MHz and the modulation used for a particular BroadcastService.
References:
https://schema.org/BroadcastFrequencySpecification
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.
broadcastSignalModulation: (Union[List[Union[str, Any]], str, Any]): The modulation (e.g. FM, AM, etc) used by a particular broadcast service.
broadcastSubChannel: (Union[List[Union[str, Any]], str, Any]): The subchannel used for the broadcast.
broadcastFrequencyValue: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The frequency in MHz for a particular broadcast.
"""
type_: str = Field(
default="BroadcastFrequencySpecification", 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.",
)
broadcastSignalModulation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The modulation (e.g. FM, AM, etc) used by a particular broadcast service.",
)
broadcastSubChannel: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The subchannel used for the broadcast.",
)
broadcastFrequencyValue: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The frequency in MHz for a particular broadcast.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/BroadcastFrequencySpecification.py
|
BroadcastFrequencySpecification.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BroadcastFrequencySpecification(BaseModel):
"""The frequency in MHz and the modulation used for a particular BroadcastService.
References:
https://schema.org/BroadcastFrequencySpecification
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.
broadcastSignalModulation: (Union[List[Union[str, Any]], str, Any]): The modulation (e.g. FM, AM, etc) used by a particular broadcast service.
broadcastSubChannel: (Union[List[Union[str, Any]], str, Any]): The subchannel used for the broadcast.
broadcastFrequencyValue: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The frequency in MHz for a particular broadcast.
"""
type_: str = Field(
default="BroadcastFrequencySpecification", 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.",
)
broadcastSignalModulation: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The modulation (e.g. FM, AM, etc) used by a particular broadcast service.",
)
broadcastSubChannel: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The subchannel used for the broadcast.",
)
broadcastFrequencyValue: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The frequency in MHz for a particular broadcast.",
)
| 0.951762 | 0.331972 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class InvestmentFund(BaseModel):
"""A company or fund that gathers capital from a number of investors to create a pool of money that is then re-invested into stocks, bonds and other assets.
References:
https://schema.org/InvestmentFund
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.
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.
amount: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The amount of money.
"""
type_: str = Field(default="InvestmentFund", 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.",
)
amount: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The amount of money.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/InvestmentFund.py
|
InvestmentFund.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class InvestmentFund(BaseModel):
"""A company or fund that gathers capital from a number of investors to create a pool of money that is then re-invested into stocks, bonds and other assets.
References:
https://schema.org/InvestmentFund
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.
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.
amount: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The amount of money.
"""
type_: str = Field(default="InvestmentFund", 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.",
)
amount: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The amount of money.",
)
| 0.918109 | 0.380831 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableMeasurementChestOrBust(BaseModel):
"""Measurement of the chest/bust section, for example of a suit
References:
https://schema.org/WearableMeasurementChestOrBust
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="WearableMeasurementChestOrBust", 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/WearableMeasurementChestOrBust.py
|
WearableMeasurementChestOrBust.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class WearableMeasurementChestOrBust(BaseModel):
"""Measurement of the chest/bust section, for example of a suit
References:
https://schema.org/WearableMeasurementChestOrBust
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="WearableMeasurementChestOrBust", 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.946039 | 0.371336 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Permit(BaseModel):
"""A permit issued by an organization, e.g. a parking pass.
References:
https://schema.org/Permit
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.
permitAudience: (Optional[Union[List[Union[str, Any]], str, Any]]): The target audience for this permit.
issuedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): The organization issuing the ticket or permit.
validUntil: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date when the item is no longer valid.
validFor: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of validity of a permit or similar thing.
validIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where a permit or similar thing is valid.
validFrom: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date when the item becomes valid.
issuedThrough: (Optional[Union[List[Union[str, Any]], str, Any]]): The service through which the permit was granted.
"""
type_: str = Field(default="Permit", 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.",
)
permitAudience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The target audience for this permit.",
)
issuedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The organization issuing the ticket or permit.",
)
validUntil: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date when the item is no longer valid.",
)
validFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of validity of a permit or similar thing.",
)
validIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where a permit or similar thing is valid.",
)
validFrom: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date when the item becomes valid.",
)
issuedThrough: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service through which the permit was granted.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Permit.py
|
Permit.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Permit(BaseModel):
"""A permit issued by an organization, e.g. a parking pass.
References:
https://schema.org/Permit
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.
permitAudience: (Optional[Union[List[Union[str, Any]], str, Any]]): The target audience for this permit.
issuedBy: (Optional[Union[List[Union[str, Any]], str, Any]]): The organization issuing the ticket or permit.
validUntil: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date when the item is no longer valid.
validFor: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration of validity of a permit or similar thing.
validIn: (Optional[Union[List[Union[str, Any]], str, Any]]): The geographic area where a permit or similar thing is valid.
validFrom: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date when the item becomes valid.
issuedThrough: (Optional[Union[List[Union[str, Any]], str, Any]]): The service through which the permit was granted.
"""
type_: str = Field(default="Permit", 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.",
)
permitAudience: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The target audience for this permit.",
)
issuedBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The organization issuing the ticket or permit.",
)
validUntil: Optional[Union[List[Union[str, Any, date]], str, Any, date]] = Field(
default=None,
description="The date when the item is no longer valid.",
)
validFor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration of validity of a permit or similar thing.",
)
validIn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The geographic area where a permit or similar thing is valid.",
)
validFrom: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date when the item becomes valid.",
)
issuedThrough: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The service through which the permit was granted.",
)
| 0.952761 | 0.299761 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TextDigitalDocument(BaseModel):
"""A file composed primarily of text.
References:
https://schema.org/TextDigitalDocument
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.
hasDigitalDocumentPermission: (Optional[Union[List[Union[str, Any]], str, Any]]): A permission related to the access to this document (e.g. permission to read or write an electronic document). For a public document, specify a grantee with an Audience with audienceType equal to "public".
"""
type_: str = Field(default="TextDigitalDocument", 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.",
)
hasDigitalDocumentPermission: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="A permission related to the access to this document (e.g. permission to read or write"
"an electronic document). For a public document, specify a grantee with an Audience with"
'audienceType equal to "public".',
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/TextDigitalDocument.py
|
TextDigitalDocument.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class TextDigitalDocument(BaseModel):
"""A file composed primarily of text.
References:
https://schema.org/TextDigitalDocument
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.
hasDigitalDocumentPermission: (Optional[Union[List[Union[str, Any]], str, Any]]): A permission related to the access to this document (e.g. permission to read or write an electronic document). For a public document, specify a grantee with an Audience with audienceType equal to "public".
"""
type_: str = Field(default="TextDigitalDocument", 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.",
)
hasDigitalDocumentPermission: Optional[
Union[List[Union[str, Any]], str, Any]
] = Field(
default=None,
description="A permission related to the access to this document (e.g. permission to read or write"
"an electronic document). For a public document, specify a grantee with an Audience with"
'audienceType equal to "public".',
)
| 0.928287 | 0.322259 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c24(BaseModel):
"""Nonprofit501c24: Non-profit type referring to Section 4049 ERISA Trusts.
References:
https://schema.org/Nonprofit501c24
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="Nonprofit501c24", 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/Nonprofit501c24.py
|
Nonprofit501c24.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Nonprofit501c24(BaseModel):
"""Nonprofit501c24: Non-profit type referring to Section 4049 ERISA Trusts.
References:
https://schema.org/Nonprofit501c24
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="Nonprofit501c24", 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.933051 | 0.264385 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BlogPosting(BaseModel):
"""A blog post.
References:
https://schema.org/BlogPosting
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.
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".
sharedContent: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork such as an image, video, or audio clip shared as part of this posting.
"""
type_: str = Field(default="BlogPosting", 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".',
)
sharedContent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork such as an image, video, or audio clip shared as part of this posting.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/BlogPosting.py
|
BlogPosting.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class BlogPosting(BaseModel):
"""A blog post.
References:
https://schema.org/BlogPosting
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.
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".
sharedContent: (Optional[Union[List[Union[str, Any]], str, Any]]): A CreativeWork such as an image, video, or audio clip shared as part of this posting.
"""
type_: str = Field(default="BlogPosting", 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".',
)
sharedContent: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A CreativeWork such as an image, video, or audio clip shared as part of this posting.",
)
| 0.922574 | 0.316409 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MerchantReturnFiniteReturnWindow(BaseModel):
"""Specifies that there is a finite window for product returns.
References:
https://schema.org/MerchantReturnFiniteReturnWindow
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="MerchantReturnFiniteReturnWindow", 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/MerchantReturnFiniteReturnWindow.py
|
MerchantReturnFiniteReturnWindow.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MerchantReturnFiniteReturnWindow(BaseModel):
"""Specifies that there is a finite window for product returns.
References:
https://schema.org/MerchantReturnFiniteReturnWindow
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="MerchantReturnFiniteReturnWindow", 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.950445 | 0.307046 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SeaBodyOfWater(BaseModel):
"""A sea (for example, the Caspian sea).
References:
https://schema.org/SeaBodyOfWater
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="SeaBodyOfWater", 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/SeaBodyOfWater.py
|
SeaBodyOfWater.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class SeaBodyOfWater(BaseModel):
"""A sea (for example, the Caspian sea).
References:
https://schema.org/SeaBodyOfWater
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="SeaBodyOfWater", 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.93871 | 0.640109 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Neuro(BaseModel):
"""Neurological system clinical examination.
References:
https://schema.org/Neuro
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.
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="Neuro", 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.",
)
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/Neuro.py
|
Neuro.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Neuro(BaseModel):
"""Neurological system clinical examination.
References:
https://schema.org/Neuro
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.
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="Neuro", 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.",
)
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.894002 | 0.348063 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MensClothingStore(BaseModel):
"""A men's clothing store.
References:
https://schema.org/MensClothingStore
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="MensClothingStore", 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/MensClothingStore.py
|
MensClothingStore.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MensClothingStore(BaseModel):
"""A men's clothing store.
References:
https://schema.org/MensClothingStore
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="MensClothingStore", 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.878581 | 0.353623 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CDCPMDRecord(BaseModel):
"""A CDCPMDRecord is a data structure representing a record in a CDC tabular data format used for hospital data reporting. See [documentation](/docs/cdc-covid.html) for details, and the linked CDC materials for authoritative definitions used as the source here.
References:
https://schema.org/CDCPMDRecord
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.
cvdNumC19MechVentPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19mechventpats - HOSPITALIZED and VENTILATED: Patients hospitalized in an NHSN inpatient care location who have suspected or confirmed COVID-19 and are on a mechanical ventilator.
cvdNumBedsOcc: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numbedsocc - HOSPITAL INPATIENT BED OCCUPANCY: Total number of staffed inpatient beds that are occupied.
cvdNumBeds: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numbeds - HOSPITAL INPATIENT BEDS: Inpatient beds, including all staffed, licensed, and overflow (surge) beds used for inpatients.
cvdNumVentUse: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numventuse - MECHANICAL VENTILATORS IN USE: Total number of ventilators in use.
cvdFacilityId: (Union[List[Union[str, Any]], str, Any]): Identifier of the NHSN facility that this data record applies to. Use [[cvdFacilityCounty]] to indicate the county. To provide other details, [[healthcareReportingData]] can be used on a [[Hospital]] entry.
cvdNumC19HospPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19hosppats - HOSPITALIZED: Patients currently hospitalized in an inpatient care location who have suspected or confirmed COVID-19.
cvdCollectionDate: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): collectiondate - Date for which patient counts are reported.
cvdNumTotBeds: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numtotbeds - ALL HOSPITAL BEDS: Total number of all inpatient and outpatient beds, including all staffed, ICU, licensed, and overflow (surge) beds used for inpatients or outpatients.
cvdFacilityCounty: (Union[List[Union[str, Any]], str, Any]): Name of the County of the NHSN facility that this data record applies to. Use [[cvdFacilityId]] to identify the facility. To provide other details, [[healthcareReportingData]] can be used on a [[Hospital]] entry.
cvdNumC19Died: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19died - DEATHS: Patients with suspected or confirmed COVID-19 who died in the hospital, ED, or any overflow location.
cvdNumVent: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numvent - MECHANICAL VENTILATORS: Total number of ventilators available.
datePosted: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Publication date of an online listing.
cvdNumICUBeds: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numicubeds - ICU BEDS: Total number of staffed inpatient intensive care unit (ICU) beds.
cvdNumC19OverflowPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19overflowpats - ED/OVERFLOW: Patients with suspected or confirmed COVID-19 who are in the ED or any overflow location awaiting an inpatient bed.
cvdNumC19HOPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19hopats - HOSPITAL ONSET: Patients hospitalized in an NHSN inpatient care location with onset of suspected or confirmed COVID-19 14 or more days after hospitalization.
cvdNumC19OFMechVentPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19ofmechventpats - ED/OVERFLOW and VENTILATED: Patients with suspected or confirmed COVID-19 who are in the ED or any overflow location awaiting an inpatient bed and on a mechanical ventilator.
cvdNumICUBedsOcc: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numicubedsocc - ICU BED OCCUPANCY: Total number of staffed inpatient ICU beds that are occupied.
"""
type_: str = Field(default="CDCPMDRecord", 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.",
)
cvdNumC19MechVentPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19mechventpats - HOSPITALIZED and VENTILATED: Patients hospitalized in an NHSN"
"inpatient care location who have suspected or confirmed COVID-19 and are on a mechanical"
"ventilator.",
)
cvdNumBedsOcc: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numbedsocc - HOSPITAL INPATIENT BED OCCUPANCY: Total number of staffed inpatient beds"
"that are occupied.",
)
cvdNumBeds: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numbeds - HOSPITAL INPATIENT BEDS: Inpatient beds, including all staffed, licensed,"
"and overflow (surge) beds used for inpatients.",
)
cvdNumVentUse: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numventuse - MECHANICAL VENTILATORS IN USE: Total number of ventilators in use.",
)
cvdFacilityId: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the NHSN facility that this data record applies to. Use [[cvdFacilityCounty]]"
"to indicate the county. To provide other details, [[healthcareReportingData]] can"
"be used on a [[Hospital]] entry.",
)
cvdNumC19HospPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19hosppats - HOSPITALIZED: Patients currently hospitalized in an inpatient care"
"location who have suspected or confirmed COVID-19.",
)
cvdCollectionDate: Union[
List[Union[datetime, str, Any]], datetime, str, Any
] = Field(
default=None,
description="collectiondate - Date for which patient counts are reported.",
)
cvdNumTotBeds: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numtotbeds - ALL HOSPITAL BEDS: Total number of all inpatient and outpatient beds, including"
"all staffed, ICU, licensed, and overflow (surge) beds used for inpatients or outpatients.",
)
cvdFacilityCounty: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Name of the County of the NHSN facility that this data record applies to. Use [[cvdFacilityId]]"
"to identify the facility. To provide other details, [[healthcareReportingData]]"
"can be used on a [[Hospital]] entry.",
)
cvdNumC19Died: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19died - DEATHS: Patients with suspected or confirmed COVID-19 who died in the hospital,"
"ED, or any overflow location.",
)
cvdNumVent: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numvent - MECHANICAL VENTILATORS: Total number of ventilators available.",
)
datePosted: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Publication date of an online listing.",
)
cvdNumICUBeds: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numicubeds - ICU BEDS: Total number of staffed inpatient intensive care unit (ICU) beds.",
)
cvdNumC19OverflowPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19overflowpats - ED/OVERFLOW: Patients with suspected or confirmed COVID-19"
"who are in the ED or any overflow location awaiting an inpatient bed.",
)
cvdNumC19HOPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19hopats - HOSPITAL ONSET: Patients hospitalized in an NHSN inpatient care location"
"with onset of suspected or confirmed COVID-19 14 or more days after hospitalization.",
)
cvdNumC19OFMechVentPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19ofmechventpats - ED/OVERFLOW and VENTILATED: Patients with suspected or confirmed"
"COVID-19 who are in the ED or any overflow location awaiting an inpatient bed and on a mechanical"
"ventilator.",
)
cvdNumICUBedsOcc: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numicubedsocc - ICU BED OCCUPANCY: Total number of staffed inpatient ICU beds that are"
"occupied.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/CDCPMDRecord.py
|
CDCPMDRecord.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CDCPMDRecord(BaseModel):
"""A CDCPMDRecord is a data structure representing a record in a CDC tabular data format used for hospital data reporting. See [documentation](/docs/cdc-covid.html) for details, and the linked CDC materials for authoritative definitions used as the source here.
References:
https://schema.org/CDCPMDRecord
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.
cvdNumC19MechVentPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19mechventpats - HOSPITALIZED and VENTILATED: Patients hospitalized in an NHSN inpatient care location who have suspected or confirmed COVID-19 and are on a mechanical ventilator.
cvdNumBedsOcc: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numbedsocc - HOSPITAL INPATIENT BED OCCUPANCY: Total number of staffed inpatient beds that are occupied.
cvdNumBeds: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numbeds - HOSPITAL INPATIENT BEDS: Inpatient beds, including all staffed, licensed, and overflow (surge) beds used for inpatients.
cvdNumVentUse: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numventuse - MECHANICAL VENTILATORS IN USE: Total number of ventilators in use.
cvdFacilityId: (Union[List[Union[str, Any]], str, Any]): Identifier of the NHSN facility that this data record applies to. Use [[cvdFacilityCounty]] to indicate the county. To provide other details, [[healthcareReportingData]] can be used on a [[Hospital]] entry.
cvdNumC19HospPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19hosppats - HOSPITALIZED: Patients currently hospitalized in an inpatient care location who have suspected or confirmed COVID-19.
cvdCollectionDate: (Union[List[Union[datetime, str, Any]], datetime, str, Any]): collectiondate - Date for which patient counts are reported.
cvdNumTotBeds: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numtotbeds - ALL HOSPITAL BEDS: Total number of all inpatient and outpatient beds, including all staffed, ICU, licensed, and overflow (surge) beds used for inpatients or outpatients.
cvdFacilityCounty: (Union[List[Union[str, Any]], str, Any]): Name of the County of the NHSN facility that this data record applies to. Use [[cvdFacilityId]] to identify the facility. To provide other details, [[healthcareReportingData]] can be used on a [[Hospital]] entry.
cvdNumC19Died: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19died - DEATHS: Patients with suspected or confirmed COVID-19 who died in the hospital, ED, or any overflow location.
cvdNumVent: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numvent - MECHANICAL VENTILATORS: Total number of ventilators available.
datePosted: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): Publication date of an online listing.
cvdNumICUBeds: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numicubeds - ICU BEDS: Total number of staffed inpatient intensive care unit (ICU) beds.
cvdNumC19OverflowPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19overflowpats - ED/OVERFLOW: Patients with suspected or confirmed COVID-19 who are in the ED or any overflow location awaiting an inpatient bed.
cvdNumC19HOPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19hopats - HOSPITAL ONSET: Patients hospitalized in an NHSN inpatient care location with onset of suspected or confirmed COVID-19 14 or more days after hospitalization.
cvdNumC19OFMechVentPats: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numc19ofmechventpats - ED/OVERFLOW and VENTILATED: Patients with suspected or confirmed COVID-19 who are in the ED or any overflow location awaiting an inpatient bed and on a mechanical ventilator.
cvdNumICUBedsOcc: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): numicubedsocc - ICU BED OCCUPANCY: Total number of staffed inpatient ICU beds that are occupied.
"""
type_: str = Field(default="CDCPMDRecord", 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.",
)
cvdNumC19MechVentPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19mechventpats - HOSPITALIZED and VENTILATED: Patients hospitalized in an NHSN"
"inpatient care location who have suspected or confirmed COVID-19 and are on a mechanical"
"ventilator.",
)
cvdNumBedsOcc: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numbedsocc - HOSPITAL INPATIENT BED OCCUPANCY: Total number of staffed inpatient beds"
"that are occupied.",
)
cvdNumBeds: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numbeds - HOSPITAL INPATIENT BEDS: Inpatient beds, including all staffed, licensed,"
"and overflow (surge) beds used for inpatients.",
)
cvdNumVentUse: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numventuse - MECHANICAL VENTILATORS IN USE: Total number of ventilators in use.",
)
cvdFacilityId: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Identifier of the NHSN facility that this data record applies to. Use [[cvdFacilityCounty]]"
"to indicate the county. To provide other details, [[healthcareReportingData]] can"
"be used on a [[Hospital]] entry.",
)
cvdNumC19HospPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19hosppats - HOSPITALIZED: Patients currently hospitalized in an inpatient care"
"location who have suspected or confirmed COVID-19.",
)
cvdCollectionDate: Union[
List[Union[datetime, str, Any]], datetime, str, Any
] = Field(
default=None,
description="collectiondate - Date for which patient counts are reported.",
)
cvdNumTotBeds: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numtotbeds - ALL HOSPITAL BEDS: Total number of all inpatient and outpatient beds, including"
"all staffed, ICU, licensed, and overflow (surge) beds used for inpatients or outpatients.",
)
cvdFacilityCounty: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Name of the County of the NHSN facility that this data record applies to. Use [[cvdFacilityId]]"
"to identify the facility. To provide other details, [[healthcareReportingData]]"
"can be used on a [[Hospital]] entry.",
)
cvdNumC19Died: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19died - DEATHS: Patients with suspected or confirmed COVID-19 who died in the hospital,"
"ED, or any overflow location.",
)
cvdNumVent: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numvent - MECHANICAL VENTILATORS: Total number of ventilators available.",
)
datePosted: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="Publication date of an online listing.",
)
cvdNumICUBeds: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numicubeds - ICU BEDS: Total number of staffed inpatient intensive care unit (ICU) beds.",
)
cvdNumC19OverflowPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19overflowpats - ED/OVERFLOW: Patients with suspected or confirmed COVID-19"
"who are in the ED or any overflow location awaiting an inpatient bed.",
)
cvdNumC19HOPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19hopats - HOSPITAL ONSET: Patients hospitalized in an NHSN inpatient care location"
"with onset of suspected or confirmed COVID-19 14 or more days after hospitalization.",
)
cvdNumC19OFMechVentPats: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numc19ofmechventpats - ED/OVERFLOW and VENTILATED: Patients with suspected or confirmed"
"COVID-19 who are in the ED or any overflow location awaiting an inpatient bed and on a mechanical"
"ventilator.",
)
cvdNumICUBedsOcc: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="numicubedsocc - ICU BED OCCUPANCY: Total number of staffed inpatient ICU beds that are"
"occupied.",
)
| 0.802981 | 0.354489 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Hackathon(BaseModel):
"""A [hackathon](https://en.wikipedia.org/wiki/Hackathon) event.
References:
https://schema.org/Hackathon
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="Hackathon", 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/Hackathon.py
|
Hackathon.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Hackathon(BaseModel):
"""A [hackathon](https://en.wikipedia.org/wiki/Hackathon) event.
References:
https://schema.org/Hackathon
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="Hackathon", 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.918425 | 0.395776 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Recruiting(BaseModel):
"""Recruiting participants.
References:
https://schema.org/Recruiting
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="Recruiting", 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/Recruiting.py
|
Recruiting.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Recruiting(BaseModel):
"""Recruiting participants.
References:
https://schema.org/Recruiting
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="Recruiting", 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.938583 | 0.313354 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Skin(BaseModel):
"""Skin assessment with clinical examination.
References:
https://schema.org/Skin
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.
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="Skin", 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.",
)
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/Skin.py
|
Skin.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Skin(BaseModel):
"""Skin assessment with clinical examination.
References:
https://schema.org/Skin
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.
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="Skin", 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.",
)
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.895574 | 0.339773 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Play(BaseModel):
"""A play is a form of literature, usually consisting of dialogue between characters, intended for theatrical performance rather than just reading. Note: A performance of a Play would be a [[TheaterEvent]] or [[BroadcastEvent]] - the *Play* being the [[workPerformed]].
References:
https://schema.org/Play
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.
"""
type_: str = Field(default="Play", 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.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/Play.py
|
Play.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Play(BaseModel):
"""A play is a form of literature, usually consisting of dialogue between characters, intended for theatrical performance rather than just reading. Note: A performance of a Play would be a [[TheaterEvent]] or [[BroadcastEvent]] - the *Play* being the [[workPerformed]].
References:
https://schema.org/Play
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.
"""
type_: str = Field(default="Play", 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.",
)
| 0.933317 | 0.353372 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ComedyEvent(BaseModel):
"""Event type: Comedy event.
References:
https://schema.org/ComedyEvent
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="ComedyEvent", 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/ComedyEvent.py
|
ComedyEvent.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ComedyEvent(BaseModel):
"""Event type: Comedy event.
References:
https://schema.org/ComedyEvent
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="ComedyEvent", 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.91626 | 0.326298 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MenuItem(BaseModel):
"""A food or drink item listed in a menu or menu section.
References:
https://schema.org/MenuItem
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.
nutrition: (Optional[Union[List[Union[str, Any]], str, Any]]): Nutrition information about the recipe or menu item.
suitableForDiet: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a dietary restriction or guideline for which this recipe or menu item is suitable, e.g. diabetic, halal etc.
menuAddOn: (Optional[Union[List[Union[str, Any]], str, Any]]): Additional menu item(s) such as a side dish of salad or side order of fries that can be added to this menu item. Additionally it can be a menu section containing allowed add-on menu items for this menu item.
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.
"""
type_: str = Field(default="MenuItem", 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.",
)
nutrition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Nutrition information about the recipe or menu item.",
)
suitableForDiet: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a dietary restriction or guideline for which this recipe or menu item is suitable,"
"e.g. diabetic, halal etc.",
)
menuAddOn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Additional menu item(s) such as a side dish of salad or side order of fries that can be added"
"to this menu item. Additionally it can be a menu section containing allowed add-on menu"
"items for this menu item.",
)
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.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MenuItem.py
|
MenuItem.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MenuItem(BaseModel):
"""A food or drink item listed in a menu or menu section.
References:
https://schema.org/MenuItem
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.
nutrition: (Optional[Union[List[Union[str, Any]], str, Any]]): Nutrition information about the recipe or menu item.
suitableForDiet: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates a dietary restriction or guideline for which this recipe or menu item is suitable, e.g. diabetic, halal etc.
menuAddOn: (Optional[Union[List[Union[str, Any]], str, Any]]): Additional menu item(s) such as a side dish of salad or side order of fries that can be added to this menu item. Additionally it can be a menu section containing allowed add-on menu items for this menu item.
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.
"""
type_: str = Field(default="MenuItem", 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.",
)
nutrition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Nutrition information about the recipe or menu item.",
)
suitableForDiet: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates a dietary restriction or guideline for which this recipe or menu item is suitable,"
"e.g. diabetic, halal etc.",
)
menuAddOn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Additional menu item(s) such as a side dish of salad or side order of fries that can be added"
"to this menu item. Additionally it can be a menu section containing allowed add-on menu"
"items for this menu item.",
)
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.",
)
| 0.919985 | 0.330579 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PrescriptionOnly(BaseModel):
"""Available by prescription only.
References:
https://schema.org/PrescriptionOnly
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="PrescriptionOnly", 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/PrescriptionOnly.py
|
PrescriptionOnly.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class PrescriptionOnly(BaseModel):
"""Available by prescription only.
References:
https://schema.org/PrescriptionOnly
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="PrescriptionOnly", 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.938548 | 0.29374 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ExerciseGym(BaseModel):
"""A gym.
References:
https://schema.org/ExerciseGym
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="ExerciseGym", 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/ExerciseGym.py
|
ExerciseGym.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ExerciseGym(BaseModel):
"""A gym.
References:
https://schema.org/ExerciseGym
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="ExerciseGym", 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.880032 | 0.332893 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ToyStore(BaseModel):
"""A toy store.
References:
https://schema.org/ToyStore
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="ToyStore", 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/ToyStore.py
|
ToyStore.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class ToyStore(BaseModel):
"""A toy store.
References:
https://schema.org/ToyStore
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="ToyStore", 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.879535 | 0.348673 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OfferForLease(BaseModel):
"""An [[OfferForLease]] in Schema.org represents an [[Offer]] to lease out something, i.e. an [[Offer]] whose [[businessFunction]] is [lease out](http://purl.org/goodrelations/v1#LeaseOut.). See [Good Relations](https://en.wikipedia.org/wiki/GoodRelations) for background on the underlying concepts.
References:
https://schema.org/OfferForLease
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.
hasMeasurement: (Optional[Union[List[Union[str, Any]], str, Any]]): A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.
eligibleQuantity: (Optional[Union[List[Union[str, Any]], str, Any]]): The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.
deliveryLeadTime: (Optional[Union[List[Union[str, Any]], str, Any]]): The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup.
availabilityEnds: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The end of the availability of the product or service included in 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.
availabilityStarts: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The beginning of the availability of the product or service included in the offer.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
advanceBookingRequirement: (Optional[Union[List[Union[str, Any]], str, Any]]): The amount of time that is required between accepting the offer and the actual usage of the resource or service.
priceValidUntil: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date after which the price is no longer available.
gtin14: (Union[List[Union[str, Any]], str, Any]): The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
warranty: (Optional[Union[List[Union[str, Any]], str, Any]]): The warranty promise(s) included in the offer.
inventoryLevel: (Optional[Union[List[Union[str, Any]], str, Any]]): The current approximate inventory level for the item or items.
eligibleDuration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration for which the given offer is valid.
availability: (Optional[Union[List[Union[str, Any]], str, Any]]): The availability of this item—for example In stock, Out of stock, Pre-order, etc.
itemCondition: (Optional[Union[List[Union[str, Any]], str, Any]]): A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.
checkoutPageURLTemplate: (Union[List[Union[str, Any]], str, Any]): A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants to specify a URL for online checkout of the offered product, by interpolating parameters such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming and standardization are not specified here.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
gtin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809) for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.
itemOffered: (Optional[Union[List[Union[str, Any]], str, Any]]): An item being offered (or demanded). The transactional nature of the offer or demand is documented using [[businessFunction]], e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
mobileUrl: (Union[List[Union[str, Any]], str, Any]): The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.
shippingDetails: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates information about the shipping policies and options associated with an [[Offer]].
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
businessFunction: (Optional[Union[List[Union[str, Any]], str, Any]]): The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
leaseLength: (Optional[Union[List[Union[str, Any]], str, Any]]): Length of the lease for some [[Accommodation]], either particular to some [[Offer]] or in some cases intrinsic to the property.
gtin12: (Union[List[Union[str, Any]], str, Any]): The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
validThrough: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
hasAdultConsideration: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to tag an item to be intended or suitable for consumption or use by adults only.
includesObject: (Optional[Union[List[Union[str, Any]], str, Any]]): This links to a node or nodes indicating the exact quantity of the products included in an [[Offer]] or [[ProductCollection]].
eligibleRegion: (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 valid.See also [[ineligibleRegion]].
asin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s article).Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details.ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.
gtin8: (Union[List[Union[str, Any]], str, Any]): The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
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]].
priceSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more detailed price specifications, indicating the unit price and delivery or payment charges.
validFrom: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date when the item becomes valid.
eligibleTransactionVolume: (Optional[Union[List[Union[str, Any]], str, Any]]): The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.
mpn: (Union[List[Union[str, Any]], str, Any]): The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
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.
offeredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to the organization or person making the offer.
addOn: (Optional[Union[List[Union[str, Any]], str, Any]]): An additional offer that can only be obtained in combination with the first base offer (e.g. supplements and extensions that are available for a surcharge).
availableAtOrFrom: (Optional[Union[List[Union[str, Any]], str, Any]]): The place(s) from which the offer can be obtained (e.g. store locations).
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
eligibleCustomerType: (Optional[Union[List[Union[str, Any]], str, Any]]): The type(s) of customers for which the given offer is valid.
gtin13: (Union[List[Union[str, Any]], str, Any]): The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
serialNumber: (Union[List[Union[str, Any]], str, Any]): The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer.
sku: (Union[List[Union[str, Any]], str, Any]): The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
acceptedPaymentMethod: (Optional[Union[List[Union[str, Any]], str, Any]]): The payment method(s) accepted by seller for this offer.
availableDeliveryMethod: (Optional[Union[List[Union[str, Any]], str, Any]]): The delivery method(s) available for this offer.
"""
type_: str = Field(default="OfferForLease", 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.",
)
hasMeasurement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A product measurement, for example the inseam of pants, the wheel size of a bicycle, or"
"the gauge of a screw. Usually an exact measurement, but can also be a range of measurements"
"for adjustable products, for example belts and ski bindings.",
)
eligibleQuantity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The interval and unit of measurement of ordering quantities for which the offer or price"
"specification is valid. This allows e.g. specifying that a certain freight charge is"
"valid only for a certain quantity.",
)
deliveryLeadTime: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The typical delay between the receipt of the order and the goods either leaving the warehouse"
"or being prepared for pickup, in case the delivery method is on site pickup.",
)
availabilityEnds: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The end of the availability of the product or service included in 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.",
)
availabilityStarts: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The beginning of the availability of the product or service included in the offer.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
advanceBookingRequirement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The amount of time that is required between accepting the offer and the actual usage of"
"the resource or service.",
)
priceValidUntil: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date after which the price is no longer available.",
)
gtin14: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN"
"Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
warranty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The warranty promise(s) included in the offer.",
)
inventoryLevel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The current approximate inventory level for the item or items.",
)
eligibleDuration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration for which the given offer is valid.",
)
availability: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The availability of this item—for example In stock, Out of stock, Pre-order,"
"etc.",
)
itemCondition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A predefined value from OfferItemCondition specifying the condition of the product"
"or service, or the products or services included in the offer. Also used for product return"
"policies to specify the condition of products accepted for returns.",
)
checkoutPageURLTemplate: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants"
"to specify a URL for online checkout of the offered product, by interpolating parameters"
"such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming"
"and standardization are not specified here.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
gtin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin))."
"GTINs identify trade items, including products and services, using numeric identification"
"codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/)"
"express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples"
"can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking"
"issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809)"
"for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN,"
"which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or"
'a "GS1 Digital Link" URL based on such a string. The numeric component should also have'
"a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator)"
"and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for"
"more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]]"
"property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]]"
"properties.Note also that this is a definition for how to include GTINs in Schema.org"
"data, and not a definition of GTINs in general - see the GS1 documentation for authoritative"
"details.",
)
itemOffered: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An item being offered (or demanded). The transactional nature of the offer or demand"
"is documented using [[businessFunction]], e.g. sell, lease etc. While several common"
"expected types are listed explicitly in this definition, others can be used. Using a"
"second type, such as Product or a subtype of Product, can clarify the nature of the offer.",
)
mobileUrl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [[mobileUrl]] property is provided for specific situations in which data consumers"
"need to determine whether one of several provided URLs is a dedicated 'mobile site'.To"
"discourage over-use, and reflecting intial usecases, the property is expected only"
"on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology"
"is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design)"
"in which content can be flexibly adapted to a wide range of browsing environments. Pages"
"and sites referenced with the long-established [[url]] property should ideally also"
"be usable on a wide variety of devices, including mobile phones. In most cases, it would"
"be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]]"
"for more mobile-oriented pages. The property is intended for the case when items (primarily"
'[[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site"'
"alongside the main one. It should not be taken as an endorsement of this publication style.",
)
shippingDetails: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates information about the shipping policies and options associated with an [[Offer]].",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
businessFunction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The business function (e.g. sell, lease, repair, dispose) of the offer or component"
"of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
leaseLength: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Length of the lease for some [[Accommodation]], either particular to some [[Offer]]"
"or in some cases intrinsic to the property.",
)
gtin12: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12"
"is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference,"
"and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
validThrough: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date after when the item is not valid. For example the end of an offer, salary period,"
"or a period of opening hours.",
)
hasAdultConsideration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to tag an item to be intended or suitable for consumption or use by adults only.",
)
includesObject: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="This links to a node or nodes indicating the exact quantity of the products included in"
"an [[Offer]] or [[ProductCollection]].",
)
eligibleRegion: 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"
"valid.See also [[ineligibleRegion]].",
)
asin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique"
"identifier assigned by Amazon.com and its partners for product identification within"
"the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s"
"article).Note also that this is a definition for how to include ASINs in Schema.org data,"
"and not a definition of ASINs in general - see documentation from Amazon for authoritative"
"details.ASINs are most commonly encoded as text strings, but the [asin] property supports"
"URL/URI as potential values too.",
)
gtin8: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-8 code of the product, or the product to which the offer refers. This code is also"
"known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
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]].",
)
priceSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more detailed price specifications, indicating the unit price and delivery or"
"payment charges.",
)
validFrom: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date when the item becomes valid.",
)
eligibleTransactionVolume: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The transaction volume, in a monetary unit, for which the offer or price specification"
"is valid, e.g. for indicating a minimal purchasing volume, to express free shipping"
"above a certain order volume, or to limit the acceptance of credit cards to purchases"
"to a certain minimal amount.",
)
mpn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.",
)
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.",
)
offeredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to the organization or person making the offer.",
)
addOn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An additional offer that can only be obtained in combination with the first base offer"
"(e.g. supplements and extensions that are available for a surcharge).",
)
availableAtOrFrom: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place(s) from which the offer can be obtained (e.g. store locations).",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
eligibleCustomerType: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The type(s) of customers for which the given offer is valid.",
)
gtin13: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent"
"to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into"
"a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
serialNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The serial number or any alphanumeric identifier of a particular product. When attached"
"to an offer, it is a shortcut for the serial number of the product included in the offer.",
)
sku: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service,"
"or the product to which the offer refers.",
)
acceptedPaymentMethod: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The payment method(s) accepted by seller for this offer.",
)
availableDeliveryMethod: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The delivery method(s) available for this offer.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/OfferForLease.py
|
OfferForLease.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class OfferForLease(BaseModel):
"""An [[OfferForLease]] in Schema.org represents an [[Offer]] to lease out something, i.e. an [[Offer]] whose [[businessFunction]] is [lease out](http://purl.org/goodrelations/v1#LeaseOut.). See [Good Relations](https://en.wikipedia.org/wiki/GoodRelations) for background on the underlying concepts.
References:
https://schema.org/OfferForLease
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.
hasMeasurement: (Optional[Union[List[Union[str, Any]], str, Any]]): A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings.
eligibleQuantity: (Optional[Union[List[Union[str, Any]], str, Any]]): The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.
deliveryLeadTime: (Optional[Union[List[Union[str, Any]], str, Any]]): The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup.
availabilityEnds: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The end of the availability of the product or service included in 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.
availabilityStarts: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The beginning of the availability of the product or service included in the offer.
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
advanceBookingRequirement: (Optional[Union[List[Union[str, Any]], str, Any]]): The amount of time that is required between accepting the offer and the actual usage of the resource or service.
priceValidUntil: (Optional[Union[List[Union[str, Any, date]], str, Any, date]]): The date after which the price is no longer available.
gtin14: (Union[List[Union[str, Any]], str, Any]): The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
reviews: (Optional[Union[List[Union[str, Any]], str, Any]]): Review of the item.
warranty: (Optional[Union[List[Union[str, Any]], str, Any]]): The warranty promise(s) included in the offer.
inventoryLevel: (Optional[Union[List[Union[str, Any]], str, Any]]): The current approximate inventory level for the item or items.
eligibleDuration: (Optional[Union[List[Union[str, Any]], str, Any]]): The duration for which the given offer is valid.
availability: (Optional[Union[List[Union[str, Any]], str, Any]]): The availability of this item—for example In stock, Out of stock, Pre-order, etc.
itemCondition: (Optional[Union[List[Union[str, Any]], str, Any]]): A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns.
checkoutPageURLTemplate: (Union[List[Union[str, Any]], str, Any]): A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants to specify a URL for online checkout of the offered product, by interpolating parameters such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming and standardization are not specified here.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
review: (Optional[Union[List[Union[str, Any]], str, Any]]): A review of the item.
gtin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809) for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties.Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details.
itemOffered: (Optional[Union[List[Union[str, Any]], str, Any]]): An item being offered (or demanded). The transactional nature of the offer or demand is documented using [[businessFunction]], e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
mobileUrl: (Union[List[Union[str, Any]], str, Any]): The [[mobileUrl]] property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'.To discourage over-use, and reflecting intial usecases, the property is expected only on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design) in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established [[url]] property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]] for more mobile-oriented pages. The property is intended for the case when items (primarily [[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style.
shippingDetails: (Optional[Union[List[Union[str, Any]], str, Any]]): Indicates information about the shipping policies and options associated with an [[Offer]].
hasMerchantReturnPolicy: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifies a MerchantReturnPolicy that may be applicable.
businessFunction: (Optional[Union[List[Union[str, Any]], str, Any]]): The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell.
isFamilyFriendly: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Indicates whether this content is family friendly.
leaseLength: (Optional[Union[List[Union[str, Any]], str, Any]]): Length of the lease for some [[Accommodation]], either particular to some [[Offer]] or in some cases intrinsic to the property.
gtin12: (Union[List[Union[str, Any]], str, Any]): The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
validThrough: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
hasAdultConsideration: (Optional[Union[List[Union[str, Any]], str, Any]]): Used to tag an item to be intended or suitable for consumption or use by adults only.
includesObject: (Optional[Union[List[Union[str, Any]], str, Any]]): This links to a node or nodes indicating the exact quantity of the products included in an [[Offer]] or [[ProductCollection]].
eligibleRegion: (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 valid.See also [[ineligibleRegion]].
asin: (Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any]): An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s article).Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details.ASINs are most commonly encoded as text strings, but the [asin] property supports URL/URI as potential values too.
gtin8: (Union[List[Union[str, Any]], str, Any]): The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
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]].
priceSpecification: (Optional[Union[List[Union[str, Any]], str, Any]]): One or more detailed price specifications, indicating the unit price and delivery or payment charges.
validFrom: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date when the item becomes valid.
eligibleTransactionVolume: (Optional[Union[List[Union[str, Any]], str, Any]]): The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.
mpn: (Union[List[Union[str, Any]], str, Any]): The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.
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.
offeredBy: (Optional[Union[List[Union[str, Any]], str, Any]]): A pointer to the organization or person making the offer.
addOn: (Optional[Union[List[Union[str, Any]], str, Any]]): An additional offer that can only be obtained in combination with the first base offer (e.g. supplements and extensions that are available for a surcharge).
availableAtOrFrom: (Optional[Union[List[Union[str, Any]], str, Any]]): The place(s) from which the offer can be obtained (e.g. store locations).
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
eligibleCustomerType: (Optional[Union[List[Union[str, Any]], str, Any]]): The type(s) of customers for which the given offer is valid.
gtin13: (Union[List[Union[str, Any]], str, Any]): The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.
serialNumber: (Union[List[Union[str, Any]], str, Any]): The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer.
sku: (Union[List[Union[str, Any]], str, Any]): The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
acceptedPaymentMethod: (Optional[Union[List[Union[str, Any]], str, Any]]): The payment method(s) accepted by seller for this offer.
availableDeliveryMethod: (Optional[Union[List[Union[str, Any]], str, Any]]): The delivery method(s) available for this offer.
"""
type_: str = Field(default="OfferForLease", 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.",
)
hasMeasurement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A product measurement, for example the inseam of pants, the wheel size of a bicycle, or"
"the gauge of a screw. Usually an exact measurement, but can also be a range of measurements"
"for adjustable products, for example belts and ski bindings.",
)
eligibleQuantity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The interval and unit of measurement of ordering quantities for which the offer or price"
"specification is valid. This allows e.g. specifying that a certain freight charge is"
"valid only for a certain quantity.",
)
deliveryLeadTime: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The typical delay between the receipt of the order and the goods either leaving the warehouse"
"or being prepared for pickup, in case the delivery method is on site pickup.",
)
availabilityEnds: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The end of the availability of the product or service included in 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.",
)
availabilityStarts: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The beginning of the availability of the product or service included in the offer.",
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
advanceBookingRequirement: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The amount of time that is required between accepting the offer and the actual usage of"
"the resource or service.",
)
priceValidUntil: Optional[
Union[List[Union[str, Any, date]], str, Any, date]
] = Field(
default=None,
description="The date after which the price is no longer available.",
)
gtin14: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN"
"Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details.",
)
reviews: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Review of the item.",
)
warranty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The warranty promise(s) included in the offer.",
)
inventoryLevel: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The current approximate inventory level for the item or items.",
)
eligibleDuration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The duration for which the given offer is valid.",
)
availability: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The availability of this item—for example In stock, Out of stock, Pre-order,"
"etc.",
)
itemCondition: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A predefined value from OfferItemCondition specifying the condition of the product"
"or service, or the products or services included in the offer. Also used for product return"
"policies to specify the condition of products accepted for returns.",
)
checkoutPageURLTemplate: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants"
"to specify a URL for online checkout of the offered product, by interpolating parameters"
"such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming"
"and standardization are not specified here.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
review: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A review of the item.",
)
gtin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin))."
"GTINs identify trade items, including products and services, using numeric identification"
"codes.The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/)"
"express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples"
"can be found in, Section 6 of the GS1 URI Syntax specification; see also [schema.org tracking"
"issue](https://github.com/schemaorg/schemaorg/issues/3156#issuecomment-1209522809)"
"for schema.org-specific discussion. A correct [[gtin]] value should be a valid GTIN,"
"which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or"
'a "GS1 Digital Link" URL based on such a string. The numeric component should also have'
"a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator)"
"and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for"
"more details. Left-padding of the gtin values is not required or encouraged. The [[gtin]]"
"property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]]"
"properties.Note also that this is a definition for how to include GTINs in Schema.org"
"data, and not a definition of GTINs in general - see the GS1 documentation for authoritative"
"details.",
)
itemOffered: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An item being offered (or demanded). The transactional nature of the offer or demand"
"is documented using [[businessFunction]], e.g. sell, lease etc. While several common"
"expected types are listed explicitly in this definition, others can be used. Using a"
"second type, such as Product or a subtype of Product, can clarify the nature of the offer.",
)
mobileUrl: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The [[mobileUrl]] property is provided for specific situations in which data consumers"
"need to determine whether one of several provided URLs is a dedicated 'mobile site'.To"
"discourage over-use, and reflecting intial usecases, the property is expected only"
"on [[Product]] and [[Offer]], rather than [[Thing]]. The general trend in web technology"
"is towards [responsive design](https://en.wikipedia.org/wiki/Responsive_web_design)"
"in which content can be flexibly adapted to a wide range of browsing environments. Pages"
"and sites referenced with the long-established [[url]] property should ideally also"
"be usable on a wide variety of devices, including mobile phones. In most cases, it would"
"be pointless and counter productive to attempt to update all [[url]] markup to use [[mobileUrl]]"
"for more mobile-oriented pages. The property is intended for the case when items (primarily"
'[[Product]] and [[Offer]]) have extra URLs hosted on an additional "mobile site"'
"alongside the main one. It should not be taken as an endorsement of this publication style.",
)
shippingDetails: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Indicates information about the shipping policies and options associated with an [[Offer]].",
)
hasMerchantReturnPolicy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifies a MerchantReturnPolicy that may be applicable.",
)
businessFunction: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The business function (e.g. sell, lease, repair, dispose) of the offer or component"
"of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell.",
)
isFamilyFriendly: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Indicates whether this content is family friendly.",
)
leaseLength: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Length of the lease for some [[Accommodation]], either particular to some [[Offer]]"
"or in some cases intrinsic to the property.",
)
gtin12: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12"
"is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference,"
"and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
validThrough: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date after when the item is not valid. For example the end of an offer, salary period,"
"or a period of opening hours.",
)
hasAdultConsideration: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Used to tag an item to be intended or suitable for consumption or use by adults only.",
)
includesObject: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="This links to a node or nodes indicating the exact quantity of the products included in"
"an [[Offer]] or [[ProductCollection]].",
)
eligibleRegion: 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"
"valid.See also [[ineligibleRegion]].",
)
asin: Union[List[Union[str, AnyUrl, Any]], str, AnyUrl, Any] = Field(
default=None,
description="An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique"
"identifier assigned by Amazon.com and its partners for product identification within"
"the Amazon organization (summary from [Wikipedia](https://en.wikipedia.org/wiki/Amazon_Standard_Identification_Number)'s"
"article).Note also that this is a definition for how to include ASINs in Schema.org data,"
"and not a definition of ASINs in general - see documentation from Amazon for authoritative"
"details.ASINs are most commonly encoded as text strings, but the [asin] property supports"
"URL/URI as potential values too.",
)
gtin8: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-8 code of the product, or the product to which the offer refers. This code is also"
"known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
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]].",
)
priceSpecification: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One or more detailed price specifications, indicating the unit price and delivery or"
"payment charges.",
)
validFrom: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date when the item becomes valid.",
)
eligibleTransactionVolume: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The transaction volume, in a monetary unit, for which the offer or price specification"
"is valid, e.g. for indicating a minimal purchasing volume, to express free shipping"
"above a certain order volume, or to limit the acceptance of credit cards to purchases"
"to a certain minimal amount.",
)
mpn: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers.",
)
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.",
)
offeredBy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A pointer to the organization or person making the offer.",
)
addOn: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="An additional offer that can only be obtained in combination with the first base offer"
"(e.g. supplements and extensions that are available for a surcharge).",
)
availableAtOrFrom: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The place(s) from which the offer can be obtained (e.g. store locations).",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
eligibleCustomerType: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The type(s) of customers for which the given offer is valid.",
)
gtin13: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent"
"to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into"
"a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin)"
"for more details.",
)
serialNumber: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The serial number or any alphanumeric identifier of a particular product. When attached"
"to an offer, it is a shortcut for the serial number of the product included in the offer.",
)
sku: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service,"
"or the product to which the offer refers.",
)
acceptedPaymentMethod: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The payment method(s) accepted by seller for this offer.",
)
availableDeliveryMethod: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The delivery method(s) available for this offer.",
)
| 0.927413 | 0.387053 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DeliveryChargeSpecification(BaseModel):
"""The price for the delivery of an offer using a particular delivery method.
References:
https://schema.org/DeliveryChargeSpecification
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.
eligibleQuantity: (Optional[Union[List[Union[str, Any]], str, Any]]): The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.
valueAddedTaxIncluded: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Specifies whether the applicable value-added tax (VAT) is included in the price specification or not.
minPrice: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The lowest price if the price is a range.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
validThrough: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
maxPrice: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The highest price if the price is a range.
validFrom: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date when the item becomes valid.
eligibleTransactionVolume: (Optional[Union[List[Union[str, Any]], str, Any]]): The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
eligibleRegion: (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 valid.See also [[ineligibleRegion]].
appliesToDeliveryMethod: (Optional[Union[List[Union[str, Any]], str, Any]]): The delivery method(s) to which the delivery charge or payment charge specification applies.
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]].
"""
type_: str = Field(default="DeliveryChargeSpecification", 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.",
)
eligibleQuantity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The interval and unit of measurement of ordering quantities for which the offer or price"
"specification is valid. This allows e.g. specifying that a certain freight charge is"
"valid only for a certain quantity.",
)
valueAddedTaxIncluded: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Specifies whether the applicable value-added tax (VAT) is included in the price specification"
"or not.",
)
minPrice: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The lowest price if the price is a range.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
validThrough: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date after when the item is not valid. For example the end of an offer, salary period,"
"or a period of opening hours.",
)
maxPrice: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The highest price if the price is a range.",
)
validFrom: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date when the item becomes valid.",
)
eligibleTransactionVolume: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The transaction volume, in a monetary unit, for which the offer or price specification"
"is valid, e.g. for indicating a minimal purchasing volume, to express free shipping"
"above a certain order volume, or to limit the acceptance of credit cards to purchases"
"to a certain minimal amount.",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
eligibleRegion: 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"
"valid.See also [[ineligibleRegion]].",
)
appliesToDeliveryMethod: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The delivery method(s) to which the delivery charge or payment charge specification"
"applies.",
)
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]].",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/DeliveryChargeSpecification.py
|
DeliveryChargeSpecification.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DeliveryChargeSpecification(BaseModel):
"""The price for the delivery of an offer using a particular delivery method.
References:
https://schema.org/DeliveryChargeSpecification
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.
eligibleQuantity: (Optional[Union[List[Union[str, Any]], str, Any]]): The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity.
valueAddedTaxIncluded: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Specifies whether the applicable value-added tax (VAT) is included in the price specification or not.
minPrice: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The lowest price if the price is a range.
price: (Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]): The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign) such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.* Note that both [RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute) and Microdata syntax allow the use of a "content=" attribute for publishing simple machine-readable values alongside more human-friendly formatting.* Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similar Unicode symbols.
validThrough: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
maxPrice: (Optional[Union[List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat]]): The highest price if the price is a range.
validFrom: (Optional[Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]]): The date when the item becomes valid.
eligibleTransactionVolume: (Optional[Union[List[Union[str, Any]], str, Any]]): The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount.
priceCurrency: (Union[List[Union[str, Any]], str, Any]): The currency of the price, or a price component when attached to [[PriceSpecification]] and its subtypes.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".
areaServed: (Union[List[Union[str, Any]], str, Any]): The geographic area where a service or offered item is provided.
eligibleRegion: (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 valid.See also [[ineligibleRegion]].
appliesToDeliveryMethod: (Optional[Union[List[Union[str, Any]], str, Any]]): The delivery method(s) to which the delivery charge or payment charge specification applies.
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]].
"""
type_: str = Field(default="DeliveryChargeSpecification", 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.",
)
eligibleQuantity: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The interval and unit of measurement of ordering quantities for which the offer or price"
"specification is valid. This allows e.g. specifying that a certain freight charge is"
"valid only for a certain quantity.",
)
valueAddedTaxIncluded: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Specifies whether the applicable value-added tax (VAT) is included in the price specification"
"or not.",
)
minPrice: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The lowest price if the price is a range.",
)
price: Union[
List[Union[str, Any, StrictInt, StrictFloat]], str, Any, StrictInt, StrictFloat
] = Field(
default=None,
description="The offer price of a product, or of a price component when attached to PriceSpecification"
"and its subtypes.Usage guidelines:* Use the [[priceCurrency]] property (with 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") instead of including [ambiguous'
"symbols](http://en.wikipedia.org/wiki/Dollar_sign#Currencies_that_use_the_dollar_or_peso_sign)"
"such as '$' in the value.* Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate"
"a decimal point. Avoid using these symbols as a readability separator.* Note that both"
"[RDFa](http://www.w3.org/TR/xhtml-rdfa-primer/#using-the-content-attribute)"
'and Microdata syntax allow the use of a "content=" attribute for publishing simple'
"machine-readable values alongside more human-friendly formatting.* Use values from"
"0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similar Unicode symbols.",
)
validThrough: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date after when the item is not valid. For example the end of an offer, salary period,"
"or a period of opening hours.",
)
maxPrice: Optional[
Union[
List[Union[str, Any, StrictInt, StrictFloat]],
str,
Any,
StrictInt,
StrictFloat,
]
] = Field(
default=None,
description="The highest price if the price is a range.",
)
validFrom: Optional[
Union[List[Union[datetime, str, Any, date]], datetime, str, Any, date]
] = Field(
default=None,
description="The date when the item becomes valid.",
)
eligibleTransactionVolume: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The transaction volume, in a monetary unit, for which the offer or price specification"
"is valid, e.g. for indicating a minimal purchasing volume, to express free shipping"
"above a certain order volume, or to limit the acceptance of credit cards to purchases"
"to a certain minimal amount.",
)
priceCurrency: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The currency of the price, or a price component when attached to [[PriceSpecification]]"
"and its subtypes.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".',
)
areaServed: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The geographic area where a service or offered item is provided.",
)
eligibleRegion: 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"
"valid.See also [[ineligibleRegion]].",
)
appliesToDeliveryMethod: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The delivery method(s) to which the delivery charge or payment charge specification"
"applies.",
)
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]].",
)
| 0.937297 | 0.521959 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MerchantReturnNotPermitted(BaseModel):
"""Specifies that product returns are not permitted.
References:
https://schema.org/MerchantReturnNotPermitted
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="MerchantReturnNotPermitted", 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/MerchantReturnNotPermitted.py
|
MerchantReturnNotPermitted.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MerchantReturnNotPermitted(BaseModel):
"""Specifies that product returns are not permitted.
References:
https://schema.org/MerchantReturnNotPermitted
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="MerchantReturnNotPermitted", 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.942022 | 0.296501 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DiagnosticLab(BaseModel):
"""A medical laboratory that offers on-site or off-site diagnostic services.
References:
https://schema.org/DiagnosticLab
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.
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.
healthPlanNetworkId: (Union[List[Union[str, Any]], str, Any]): Name or unique ID of network. (Networks are often reused across different insurance plans.)
medicalSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical specialty of the provider.
isAcceptingNewPatients: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Whether the provider is accepting new patients.
availableTest: (Optional[Union[List[Union[str, Any]], str, Any]]): A diagnostic test or procedure offered by this lab.
"""
type_: str = Field(default="DiagnosticLab", 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.",
)
healthPlanNetworkId: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Name or unique ID of network. (Networks are often reused across different insurance"
"plans.)",
)
medicalSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical specialty of the provider.",
)
isAcceptingNewPatients: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Whether the provider is accepting new patients.",
)
availableTest: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A diagnostic test or procedure offered by this lab.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/DiagnosticLab.py
|
DiagnosticLab.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class DiagnosticLab(BaseModel):
"""A medical laboratory that offers on-site or off-site diagnostic services.
References:
https://schema.org/DiagnosticLab
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.
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.
healthPlanNetworkId: (Union[List[Union[str, Any]], str, Any]): Name or unique ID of network. (Networks are often reused across different insurance plans.)
medicalSpecialty: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical specialty of the provider.
isAcceptingNewPatients: (Optional[Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]]): Whether the provider is accepting new patients.
availableTest: (Optional[Union[List[Union[str, Any]], str, Any]]): A diagnostic test or procedure offered by this lab.
"""
type_: str = Field(default="DiagnosticLab", 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.",
)
healthPlanNetworkId: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Name or unique ID of network. (Networks are often reused across different insurance"
"plans.)",
)
medicalSpecialty: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical specialty of the provider.",
)
isAcceptingNewPatients: Optional[
Union[List[Union[str, StrictBool, Any]], str, StrictBool, Any]
] = Field(
default=None,
description="Whether the provider is accepting new patients.",
)
availableTest: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A diagnostic test or procedure offered by this lab.",
)
| 0.874854 | 0.361221 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Eye(BaseModel):
"""Eye or ophthalmological function assessment with clinical examination.
References:
https://schema.org/Eye
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.
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="Eye", 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.",
)
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/Eye.py
|
Eye.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Eye(BaseModel):
"""Eye or ophthalmological function assessment with clinical examination.
References:
https://schema.org/Eye
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.
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="Eye", 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.",
)
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.907138 | 0.36108 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Observational(BaseModel):
"""An observational study design.
References:
https://schema.org/Observational
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="Observational", 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/Observational.py
|
Observational.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class Observational(BaseModel):
"""An observational study design.
References:
https://schema.org/Observational
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="Observational", 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.941587 | 0.335868 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalSign(BaseModel):
"""Any physical manifestation of a person's medical condition discoverable by objective diagnostic tests or physical examination.
References:
https://schema.org/MedicalSign
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.
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.
riskFactor: (Optional[Union[List[Union[str, Any]], str, Any]]): A modifiable or non-modifiable factor that increases the risk of a patient contracting this condition, e.g. age, coexisting condition.
primaryPrevention: (Optional[Union[List[Union[str, Any]], str, Any]]): A preventative therapy used to prevent an initial occurrence of the medical condition, such as vaccination.
expectedPrognosis: (Union[List[Union[str, Any]], str, Any]): The likely outcome in either the short term or long term of the medical condition.
typicalTest: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical test typically performed given this condition.
differentialDiagnosis: (Optional[Union[List[Union[str, Any]], str, Any]]): One of a set of differential diagnoses for the condition. Specifically, a closely-related or competing diagnosis typically considered later in the cognitive process whereby this medical condition is distinguished from others most likely responsible for a similar collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses in a patient.
pathophysiology: (Union[List[Union[str, Any]], str, Any]): Changes in the normal mechanical, physical, and biochemical functions that are associated with this activity or condition.
status: (Union[List[Union[str, Any]], str, Any]): The status of the study (enumerated).
naturalProgression: (Union[List[Union[str, Any]], str, Any]): The expected progression of the condition if it is not treated and allowed to progress naturally.
drug: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifying a drug or medicine used in a medication procedure.
secondaryPrevention: (Optional[Union[List[Union[str, Any]], str, Any]]): A preventative therapy used to prevent reoccurrence of the medical condition after an initial episode of the condition.
signOrSymptom: (Optional[Union[List[Union[str, Any]], str, Any]]): A sign or symptom of this condition. Signs are objective or physically observable manifestations of the medical condition while symptoms are the subjective experience of the medical condition.
possibleTreatment: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible treatment to address this condition, sign or symptom.
epidemiology: (Union[List[Union[str, Any]], str, Any]): The characteristics of associated patients, such as age, gender, race etc.
associatedAnatomy: (Optional[Union[List[Union[str, Any]], str, Any]]): The anatomy of the underlying organ system or structures associated with this entity.
possibleComplication: (Union[List[Union[str, Any]], str, Any]): A possible unexpected and unfavorable evolution of a medical condition. Complications may include worsening of the signs or symptoms of the disease, extension of the condition to other organ systems, etc.
stage: (Optional[Union[List[Union[str, Any]], str, Any]]): The stage of the condition, if applicable.
possibleTreatment: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible treatment to address this condition, sign or symptom.
identifyingExam: (Optional[Union[List[Union[str, Any]], str, Any]]): A physical examination that can identify this sign.
identifyingTest: (Optional[Union[List[Union[str, Any]], str, Any]]): A diagnostic test that can identify this sign.
"""
type_: str = Field(default="MedicalSign", 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.",
)
riskFactor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A modifiable or non-modifiable factor that increases the risk of a patient contracting"
"this condition, e.g. age, coexisting condition.",
)
primaryPrevention: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A preventative therapy used to prevent an initial occurrence of the medical condition,"
"such as vaccination.",
)
expectedPrognosis: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The likely outcome in either the short term or long term of the medical condition.",
)
typicalTest: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical test typically performed given this condition.",
)
differentialDiagnosis: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One of a set of differential diagnoses for the condition. Specifically, a closely-related"
"or competing diagnosis typically considered later in the cognitive process whereby"
"this medical condition is distinguished from others most likely responsible for a similar"
"collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses"
"in a patient.",
)
pathophysiology: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Changes in the normal mechanical, physical, and biochemical functions that are associated"
"with this activity or condition.",
)
status: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of the study (enumerated).",
)
naturalProgression: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The expected progression of the condition if it is not treated and allowed to progress"
"naturally.",
)
drug: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifying a drug or medicine used in a medication procedure.",
)
secondaryPrevention: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A preventative therapy used to prevent reoccurrence of the medical condition after"
"an initial episode of the condition.",
)
signOrSymptom: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sign or symptom of this condition. Signs are objective or physically observable manifestations"
"of the medical condition while symptoms are the subjective experience of the medical"
"condition.",
)
possibleTreatment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible treatment to address this condition, sign or symptom.",
)
epidemiology: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The characteristics of associated patients, such as age, gender, race etc.",
)
associatedAnatomy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The anatomy of the underlying organ system or structures associated with this entity.",
)
possibleComplication: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A possible unexpected and unfavorable evolution of a medical condition. Complications"
"may include worsening of the signs or symptoms of the disease, extension of the condition"
"to other organ systems, etc.",
)
stage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The stage of the condition, if applicable.",
)
possibleTreatment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible treatment to address this condition, sign or symptom.",
)
identifyingExam: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A physical examination that can identify this sign.",
)
identifyingTest: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A diagnostic test that can identify this sign.",
)
|
schemaorg-types
|
/schemaorg_types-0.4.0.tar.gz/schemaorg_types-0.4.0/schemaorg_types/MedicalSign.py
|
MedicalSign.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class MedicalSign(BaseModel):
"""Any physical manifestation of a person's medical condition discoverable by objective diagnostic tests or physical examination.
References:
https://schema.org/MedicalSign
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.
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.
riskFactor: (Optional[Union[List[Union[str, Any]], str, Any]]): A modifiable or non-modifiable factor that increases the risk of a patient contracting this condition, e.g. age, coexisting condition.
primaryPrevention: (Optional[Union[List[Union[str, Any]], str, Any]]): A preventative therapy used to prevent an initial occurrence of the medical condition, such as vaccination.
expectedPrognosis: (Union[List[Union[str, Any]], str, Any]): The likely outcome in either the short term or long term of the medical condition.
typicalTest: (Optional[Union[List[Union[str, Any]], str, Any]]): A medical test typically performed given this condition.
differentialDiagnosis: (Optional[Union[List[Union[str, Any]], str, Any]]): One of a set of differential diagnoses for the condition. Specifically, a closely-related or competing diagnosis typically considered later in the cognitive process whereby this medical condition is distinguished from others most likely responsible for a similar collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses in a patient.
pathophysiology: (Union[List[Union[str, Any]], str, Any]): Changes in the normal mechanical, physical, and biochemical functions that are associated with this activity or condition.
status: (Union[List[Union[str, Any]], str, Any]): The status of the study (enumerated).
naturalProgression: (Union[List[Union[str, Any]], str, Any]): The expected progression of the condition if it is not treated and allowed to progress naturally.
drug: (Optional[Union[List[Union[str, Any]], str, Any]]): Specifying a drug or medicine used in a medication procedure.
secondaryPrevention: (Optional[Union[List[Union[str, Any]], str, Any]]): A preventative therapy used to prevent reoccurrence of the medical condition after an initial episode of the condition.
signOrSymptom: (Optional[Union[List[Union[str, Any]], str, Any]]): A sign or symptom of this condition. Signs are objective or physically observable manifestations of the medical condition while symptoms are the subjective experience of the medical condition.
possibleTreatment: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible treatment to address this condition, sign or symptom.
epidemiology: (Union[List[Union[str, Any]], str, Any]): The characteristics of associated patients, such as age, gender, race etc.
associatedAnatomy: (Optional[Union[List[Union[str, Any]], str, Any]]): The anatomy of the underlying organ system or structures associated with this entity.
possibleComplication: (Union[List[Union[str, Any]], str, Any]): A possible unexpected and unfavorable evolution of a medical condition. Complications may include worsening of the signs or symptoms of the disease, extension of the condition to other organ systems, etc.
stage: (Optional[Union[List[Union[str, Any]], str, Any]]): The stage of the condition, if applicable.
possibleTreatment: (Optional[Union[List[Union[str, Any]], str, Any]]): A possible treatment to address this condition, sign or symptom.
identifyingExam: (Optional[Union[List[Union[str, Any]], str, Any]]): A physical examination that can identify this sign.
identifyingTest: (Optional[Union[List[Union[str, Any]], str, Any]]): A diagnostic test that can identify this sign.
"""
type_: str = Field(default="MedicalSign", 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.",
)
riskFactor: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A modifiable or non-modifiable factor that increases the risk of a patient contracting"
"this condition, e.g. age, coexisting condition.",
)
primaryPrevention: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A preventative therapy used to prevent an initial occurrence of the medical condition,"
"such as vaccination.",
)
expectedPrognosis: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The likely outcome in either the short term or long term of the medical condition.",
)
typicalTest: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A medical test typically performed given this condition.",
)
differentialDiagnosis: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="One of a set of differential diagnoses for the condition. Specifically, a closely-related"
"or competing diagnosis typically considered later in the cognitive process whereby"
"this medical condition is distinguished from others most likely responsible for a similar"
"collection of signs and symptoms to reach the most parsimonious diagnosis or diagnoses"
"in a patient.",
)
pathophysiology: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="Changes in the normal mechanical, physical, and biochemical functions that are associated"
"with this activity or condition.",
)
status: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The status of the study (enumerated).",
)
naturalProgression: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The expected progression of the condition if it is not treated and allowed to progress"
"naturally.",
)
drug: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="Specifying a drug or medicine used in a medication procedure.",
)
secondaryPrevention: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A preventative therapy used to prevent reoccurrence of the medical condition after"
"an initial episode of the condition.",
)
signOrSymptom: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A sign or symptom of this condition. Signs are objective or physically observable manifestations"
"of the medical condition while symptoms are the subjective experience of the medical"
"condition.",
)
possibleTreatment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible treatment to address this condition, sign or symptom.",
)
epidemiology: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="The characteristics of associated patients, such as age, gender, race etc.",
)
associatedAnatomy: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The anatomy of the underlying organ system or structures associated with this entity.",
)
possibleComplication: Union[List[Union[str, Any]], str, Any] = Field(
default=None,
description="A possible unexpected and unfavorable evolution of a medical condition. Complications"
"may include worsening of the signs or symptoms of the disease, extension of the condition"
"to other organ systems, etc.",
)
stage: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="The stage of the condition, if applicable.",
)
possibleTreatment: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A possible treatment to address this condition, sign or symptom.",
)
identifyingExam: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A physical examination that can identify this sign.",
)
identifyingTest: Optional[Union[List[Union[str, Any]], str, Any]] = Field(
default=None,
description="A diagnostic test that can identify this sign.",
)
| 0.924908 | 0.39905 |
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CollegeOrUniversity(BaseModel):
"""A college, university, or other third-level educational institution.
References:
https://schema.org/CollegeOrUniversity
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).
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="CollegeOrUniversity", 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/CollegeOrUniversity.py
|
CollegeOrUniversity.py
|
from __future__ import annotations
from datetime import *
from time import *
from typing import *
from pydantic import *
class CollegeOrUniversity(BaseModel):
"""A college, university, or other third-level educational institution.
References:
https://schema.org/CollegeOrUniversity
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).
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="CollegeOrUniversity", 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.937074 | 0.622172 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.