Skip to content

Commit

Permalink
update models, for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
crbaker89 committed Feb 17, 2022
1 parent c7730af commit 5d9d599
Show file tree
Hide file tree
Showing 380 changed files with 2,791 additions and 2,791 deletions.
12 changes: 6 additions & 6 deletions pydantic_schemaorg/APIReference.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from __future__ import annotations
from typing import TYPE_CHECKING

from typing import Union, Optional, List
from typing import List, Optional, Union


from pydantic import Field
Expand All @@ -16,23 +16,23 @@ class APIReference(TechArticle):
"""
type_: str = Field("APIReference", alias='@type')
assemblyVersion: Optional[Union[List[Union[str, 'Text']], str, 'Text']] = Field(
None,
default=None,
description="Associated product/technology version. e.g., .NET Framework 4.5.",
)
programmingModel: Optional[Union[List[Union[str, 'Text']], str, 'Text']] = Field(
None,
default=None,
description="Indicates whether API is managed or unmanaged.",
)
assembly: Optional[Union[List[Union[str, 'Text']], str, 'Text']] = Field(
None,
default=None,
description="Library file name e.g., mscorlib.dll, system.web.dll.",
)
executableLibraryName: Optional[Union[List[Union[str, 'Text']], str, 'Text']] = Field(
None,
default=None,
description="Library file name e.g., mscorlib.dll, system.web.dll.",
)
targetPlatform: Optional[Union[List[Union[str, 'Text']], str, 'Text']] = Field(
None,
default=None,
description="Type of app development: phone, Metro style, desktop, XBox, etc.",
)

Expand Down
36 changes: 18 additions & 18 deletions pydantic_schemaorg/Accommodation.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
from typing import TYPE_CHECKING

from decimal import Decimal
from typing import Union, Optional, List
from pydantic import StrictBool, AnyUrl
from typing import List, Optional, Union
from pydantic import AnyUrl, StrictBool


from pydantic import Field
Expand All @@ -22,82 +22,82 @@ class Accommodation(Place):
"""
type_: str = Field("Accommodation", alias='@type')
numberOfBedrooms: Optional[Union[List[Union[Decimal, 'Number', 'QuantitativeValue', str]], Decimal, 'Number', 'QuantitativeValue', str]] = Field(
None,
default=None,
description="The total integer number of bedrooms in a some [[Accommodation]], [[ApartmentComplex]]"
"or [[FloorPlan]].",
)
numberOfBathroomsTotal: Optional[Union[List[Union[int, 'Integer', str]], int, 'Integer', str]] = Field(
None,
default=None,
description="The total integer number of bathrooms in a some [[Accommodation]], following real estate"
"conventions as [documented in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsTotalInteger+Field):"
"\"The simple sum of the number of bathrooms. For example for a property with two Full Bathrooms"
"and one Half Bathroom, the Bathrooms Total Integer will be 3.\". See also [[numberOfRooms]].",
)
permittedUsage: Optional[Union[List[Union[str, 'Text']], str, 'Text']] = Field(
None,
default=None,
description="Indications regarding the permitted usage of the accommodation.",
)
numberOfPartialBathrooms: Optional[Union[List[Union[Decimal, 'Number', str]], Decimal, 'Number', str]] = Field(
None,
default=None,
description="Number of partial bathrooms - The total number of half and ¼ bathrooms in an [[Accommodation]]."
"This corresponds to the [BathroomsPartial field in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsPartial+Field).",
)
yearBuilt: Optional[Union[List[Union[Decimal, 'Number', str]], Decimal, 'Number', str]] = Field(
None,
default=None,
description="The year an [[Accommodation]] was constructed. This corresponds to the [YearBuilt"
"field in RESO](https://ddwiki.reso.org/display/DDW17/YearBuilt+Field).",
)
leaseLength: Optional[Union[List[Union['Duration', 'QuantitativeValue', str]], 'Duration', 'QuantitativeValue', str]] = Field(
None,
leaseLength: Optional[Union[List[Union['QuantitativeValue', 'Duration', str]], 'QuantitativeValue', 'Duration', str]] = Field(
default=None,
description="Length of the lease for some [[Accommodation]], either particular to some [[Offer]]"
"or in some cases intrinsic to the property.",
)
amenityFeature: Optional[Union[List[Union['LocationFeatureSpecification', str]], 'LocationFeatureSpecification', str]] = Field(
None,
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.",
)
numberOfRooms: Optional[Union[List[Union[Decimal, 'Number', 'QuantitativeValue', str]], Decimal, 'Number', 'QuantitativeValue', str]] = Field(
None,
default=None,
description="The number of rooms (excluding bathrooms and closets) of the accommodation or lodging"
"business. Typical unit code(s): ROM for room or C62 for no unit. The type of room can be"
"put in the unitText property of the QuantitativeValue.",
)
tourBookingPage: Optional[Union[List[Union[AnyUrl, 'URL', str]], AnyUrl, 'URL', str]] = Field(
None,
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.",
)
petsAllowed: Optional[Union[List[Union[StrictBool, 'Boolean', str, 'Text']], StrictBool, 'Boolean', str, 'Text']] = Field(
None,
default=None,
description="Indicates whether pets are allowed to enter the accommodation or lodging business."
"More detailed information can be put in a text value.",
)
accommodationCategory: Optional[Union[List[Union[str, 'Text']], str, 'Text']] = Field(
None,
default=None,
description="Category of an [[Accommodation]], following real estate conventions e.g. RESO (see"
"[PropertySubType](https://ddwiki.reso.org/display/DDW17/PropertySubType+Field),"
"and [PropertyType](https://ddwiki.reso.org/display/DDW17/PropertyType+Field)"
"fields for suggested values).",
)
floorLevel: Optional[Union[List[Union[str, 'Text']], str, 'Text']] = Field(
None,
default=None,
description="The floor level for an [[Accommodation]] in a multi-storey building. Since counting"
"systems [vary internationally](https://en.wikipedia.org/wiki/Storey#Consecutive_number_floor_designations),"
"the local system should be used where possible.",
)
floorSize: Optional[Union[List[Union['QuantitativeValue', str]], 'QuantitativeValue', str]] = Field(
None,
default=None,
description="The size of the accommodation, e.g. in square meter or squarefoot. Typical unit code(s):"
"MTK for square meter, FTK for square foot, or YDK for square yard",
)
accommodationFloorPlan: Optional[Union[List[Union['FloorPlan', str]], 'FloorPlan', str]] = Field(
None,
default=None,
description="A floorplan of some [[Accommodation]].",
)
numberOfFullBathrooms: Optional[Union[List[Union[Decimal, 'Number', str]], Decimal, 'Number', str]] = Field(
None,
default=None,
description="Number of full bathrooms - The total number of full and ¾ bathrooms in an [[Accommodation]]."
"This corresponds to the [BathroomsFull field in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsFull+Field).",
)
Expand Down
32 changes: 16 additions & 16 deletions pydantic_schemaorg/Action.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from __future__ import annotations
from typing import TYPE_CHECKING

from typing import Union, Optional, List
from typing import List, Optional, Union
from pydantic_schemaorg.ISO8601.ISO8601Date import ISO8601Date
from datetime import time

Expand All @@ -22,31 +22,31 @@ class Action(Thing):
"""
type_: str = Field("Action", alias='@type')
result: Optional[Union[List[Union['Thing', str]], 'Thing', str]] = Field(
None,
default=None,
description="The result produced in the action. e.g. John wrote *a book*.",
)
object: Optional[Union[List[Union['Thing', str]], 'Thing', str]] = Field(
None,
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*.",
)
participant: Optional[Union[List[Union['Organization', 'Person', str]], 'Organization', 'Person', str]] = Field(
None,
participant: Optional[Union[List[Union['Person', 'Organization', str]], 'Person', 'Organization', str]] = Field(
default=None,
description="Other co-agents that participated in the action indirectly. e.g. John wrote a book with"
"*Steve*.",
)
error: Optional[Union[List[Union['Thing', str]], 'Thing', str]] = Field(
None,
default=None,
description="For failed actions, more information on the cause of the failure.",
)
location: Optional[Union[List[Union[str, 'Text', 'PostalAddress', 'Place', 'VirtualLocation']], str, 'Text', 'PostalAddress', 'Place', 'VirtualLocation']] = Field(
None,
location: Optional[Union[List[Union[str, 'Text', 'Place', 'VirtualLocation', 'PostalAddress']], str, 'Text', 'Place', 'VirtualLocation', 'PostalAddress']] = 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.",
)
endTime: Optional[Union[List[Union[ISO8601Date, 'DateTime', time, 'Time', str]], ISO8601Date, 'DateTime', time, 'Time', str]] = Field(
None,
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"
Expand All @@ -55,24 +55,24 @@ class Action(Thing):
"dates with times. This situation may be clarified in future revisions.",
)
agent: Optional[Union[List[Union['Person', 'Organization', str]], 'Person', 'Organization', str]] = Field(
None,
default=None,
description="The direct performer or driver of the action (animate or inanimate). e.g. *John* wrote"
"a book.",
)
target: Optional[Union[List[Union['EntryPoint', str]], 'EntryPoint', str]] = Field(
None,
default=None,
description="Indicates a target EntryPoint for an Action.",
)
actionStatus: Optional[Union[List[Union['ActionStatusType', str]], 'ActionStatusType', str]] = Field(
None,
default=None,
description="Indicates the current disposition of the Action.",
)
instrument: Optional[Union[List[Union['Thing', str]], 'Thing', str]] = Field(
None,
default=None,
description="The object that helped the agent perform the action. e.g. John wrote a book with *a pen*.",
)
startTime: Optional[Union[List[Union[ISO8601Date, 'DateTime', time, 'Time', str]], ISO8601Date, 'DateTime', time, 'Time', str]] = Field(
None,
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"
Expand All @@ -85,12 +85,12 @@ class Action(Thing):

if TYPE_CHECKING:
from pydantic_schemaorg.Thing import Thing
from pydantic_schemaorg.Organization import Organization
from pydantic_schemaorg.Person import Person
from pydantic_schemaorg.Organization import Organization
from pydantic_schemaorg.Text import Text
from pydantic_schemaorg.PostalAddress import PostalAddress
from pydantic_schemaorg.Place import Place
from pydantic_schemaorg.VirtualLocation import VirtualLocation
from pydantic_schemaorg.PostalAddress import PostalAddress
from pydantic_schemaorg.DateTime import DateTime
from pydantic_schemaorg.Time import Time
from pydantic_schemaorg.EntryPoint import EntryPoint
Expand Down
24 changes: 12 additions & 12 deletions pydantic_schemaorg/ActionAccessSpecification.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
from __future__ import annotations
from typing import TYPE_CHECKING

from pydantic import StrictBool, AnyUrl
from typing import Union, Optional, List
from pydantic import AnyUrl, StrictBool
from typing import List, Optional, Union
from pydantic_schemaorg.ISO8601.ISO8601Date import ISO8601Date
from datetime import time

Expand All @@ -19,36 +19,36 @@ class ActionAccessSpecification(Intangible):
"""
type_: str = Field("ActionAccessSpecification", alias='@type')
category: Optional[Union[List[Union[AnyUrl, 'URL', str, 'Text', 'Thing', 'PhysicalActivityCategory']], AnyUrl, 'URL', str, 'Text', 'Thing', 'PhysicalActivityCategory']] = Field(
None,
default=None,
description="A category for the item. Greater signs or slashes can be used to informally indicate a"
"category hierarchy.",
)
availabilityStarts: Optional[Union[List[Union[ISO8601Date, 'DateTime', time, 'Time', ISO8601Date, 'Date', str]], ISO8601Date, 'DateTime', time, 'Time', ISO8601Date, 'Date', str]] = Field(
None,
availabilityStarts: Optional[Union[List[Union[ISO8601Date, 'DateTime', ISO8601Date, 'Date', time, 'Time', str]], ISO8601Date, 'DateTime', ISO8601Date, 'Date', time, 'Time', str]] = Field(
default=None,
description="The beginning of the availability of the product or service included in the offer.",
)
eligibleRegion: Optional[Union[List[Union[str, 'Text', 'GeoShape', 'Place']], str, 'Text', 'GeoShape', 'Place']] = Field(
None,
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]].",
)
requiresSubscription: Optional[Union[List[Union[StrictBool, 'Boolean', 'MediaSubscription', str]], StrictBool, 'Boolean', 'MediaSubscription', str]] = Field(
None,
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').",
)
expectsAcceptanceOf: Optional[Union[List[Union['Offer', str]], 'Offer', str]] = Field(
None,
default=None,
description="An Offer which must be accepted before the user can perform the Action. For example, the"
"user may need to buy a movie before being able to watch it.",
)
availabilityEnds: Optional[Union[List[Union[ISO8601Date, 'DateTime', time, 'Time', ISO8601Date, 'Date', str]], ISO8601Date, 'DateTime', time, 'Time', ISO8601Date, 'Date', str]] = Field(
None,
availabilityEnds: Optional[Union[List[Union[ISO8601Date, 'DateTime', ISO8601Date, 'Date', time, 'Time', str]], ISO8601Date, 'DateTime', ISO8601Date, 'Date', time, 'Time', str]] = Field(
default=None,
description="The end of the availability of the product or service included in the offer.",
)
ineligibleRegion: Optional[Union[List[Union[str, 'Text', 'GeoShape', 'Place']], str, 'Text', 'GeoShape', 'Place']] = Field(
None,
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]].",
Expand All @@ -62,8 +62,8 @@ class ActionAccessSpecification(Intangible):
from pydantic_schemaorg.Thing import Thing
from pydantic_schemaorg.PhysicalActivityCategory import PhysicalActivityCategory
from pydantic_schemaorg.DateTime import DateTime
from pydantic_schemaorg.Time import Time
from pydantic_schemaorg.Date import Date
from pydantic_schemaorg.Time import Time
from pydantic_schemaorg.GeoShape import GeoShape
from pydantic_schemaorg.Place import Place
from pydantic_schemaorg.Boolean import Boolean
Expand Down
10 changes: 5 additions & 5 deletions pydantic_schemaorg/AggregateOffer.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from __future__ import annotations
from typing import TYPE_CHECKING

from typing import Union, Optional, List
from typing import List, Optional, Union
from decimal import Decimal


Expand All @@ -21,7 +21,7 @@ class AggregateOffer(Offer):
"""
type_: str = Field("AggregateOffer", alias='@type')
offers: Optional[Union[List[Union['Demand', 'Offer', str]], 'Demand', 'Offer', str]] = Field(
None,
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"
Expand All @@ -30,21 +30,21 @@ class AggregateOffer(Offer):
"or a subtype of Product, can clarify the nature of the offer.",
)
lowPrice: Optional[Union[List[Union[Decimal, 'Number', str, 'Text']], Decimal, 'Number', str, 'Text']] = Field(
None,
default=None,
description="The lowest price of all offers available. Usage guidelines: * Use values from 0123456789"
"(Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similiar Unicode symbols. * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to"
"indicate a decimal point. Avoid using these symbols as a readability separator.",
)
highPrice: Optional[Union[List[Union[Decimal, 'Number', str, 'Text']], Decimal, 'Number', str, 'Text']] = Field(
None,
default=None,
description="The highest price of all offers available. Usage guidelines: * Use values from 0123456789"
"(Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially"
"similiar Unicode symbols. * Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to"
"indicate a decimal point. Avoid using these symbols as a readability separator.",
)
offerCount: Optional[Union[List[Union[int, 'Integer', str]], int, 'Integer', str]] = Field(
None,
default=None,
description="The number of offers for the product.",
)

Expand Down
8 changes: 4 additions & 4 deletions pydantic_schemaorg/AggregateRating.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from __future__ import annotations
from typing import TYPE_CHECKING

from typing import Union, Optional, List
from typing import List, Optional, Union


from pydantic import Field
Expand All @@ -16,15 +16,15 @@ class AggregateRating(Rating):
"""
type_: str = Field("AggregateRating", alias='@type')
reviewCount: Optional[Union[List[Union[int, 'Integer', str]], int, 'Integer', str]] = Field(
None,
default=None,
description="The count of total number of reviews.",
)
ratingCount: Optional[Union[List[Union[int, 'Integer', str]], int, 'Integer', str]] = Field(
None,
default=None,
description="The count of total number of ratings.",
)
itemReviewed: Optional[Union[List[Union['Thing', str]], 'Thing', str]] = Field(
None,
default=None,
description="The item that is being reviewed/rated.",
)

Expand Down
Loading

0 comments on commit 5d9d599

Please sign in to comment.