schema-dts v0.5.1 to v0.5.2 diff

Created Diff never expires
11 removals
344 lines
8 additions
339 lines
/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
/** Used at the top-level node to indicate the context for the JSON-LD objects used. The context provided in this type is compatible with the keys and URLs in the rest of this generated file. */
export declare type WithContext<T extends Thing> = T & {
export declare type WithContext<T extends Thing> = T & {
"@context": "https://schema.org";
"@context": "https://schema.org";
};
};
/** Boolean: True or False. */
/** Boolean: True or False. */
export declare type Boolean = true | false | "https://schema.org/True" | "https://schema.org/False";
export declare type Boolean = true | false | "https://schema.org/True" | "https://schema.org/False";
export declare const Boolean: {
export declare const Boolean: {
True: "https://schema.org/True";
True: "https://schema.org/True";
False: "https://schema.org/False";
False: "https://schema.org/False";
};
};
/** A date value in {@link http://en.wikipedia.org/wiki/ISO_8601 ISO 8601 date format}. */
/** A date value in {@link http://en.wikipedia.org/wiki/ISO_8601 ISO 8601 date format}. */
export declare type Date = string;
export declare type Date = string;
/** A combination of date and time of day in the form [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm] (see Chapter 5.4 of ISO 8601). */
/** A combination of date and time of day in the form [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm] (see Chapter 5.4 of ISO 8601). */
export declare type DateTime = string;
export declare type DateTime = string;
/** Data type: Number. */
/** Data type: Number. */
export declare type Number = number;
export declare type Number = number;
/** Data type: Text. */
/** Data type: Text. */
export declare type Text = string;
export declare type Text = string;
/** DateTime represented in string, e.g. 2017-01-04T17:10:00-05:00. */
/** DateTime represented in string, e.g. 2017-01-04T17:10:00-05:00. */
export declare type Time = string;
export declare type Time = string;
/** The basic data types such as Integers, Strings, etc. */
/** The basic data types such as Integers, Strings, etc. */
export declare type DataType = Text | Number | Time | Date | DateTime | Boolean;
export declare type DataType = Text | Number | Time | Date | DateTime | Boolean;
declare type _3DModelBase = CreativeWorkBase & {
declare type _3DModelBase = CreativeWorkBase & {
/** Whether the 3DModel allows resizing. For example, room layout applications often do not allow 3DModel elements to be resized to reflect reality. */
/** Whether the 3DModel allows resizing. For example, room layout applications often do not allow 3DModel elements to be resized to reflect reality. */
"isResizable"?: Boolean | readonly Boolean[];
"isResizable"?: Boolean | readonly Boolean[];
};
};
/** A 3D model represents some kind of 3D content, which may have {@link http://schema.org/encoding encoding}s in one or more {@link http://schema.org/MediaObject MediaObject}s. Many 3D formats are available (e.g. see {@link https://en.wikipedia.org/wiki/Category:3D_graphics_file_formats Wikipedia}); specific encoding formats can be represented using the {@link http://schema.org/encodingFormat encodingFormat} property applied to the relevant {@link http://schema.org/MediaObject MediaObject}. For thecase of a single file published after Zip compression, the convention of appending '+zip' to the {@link http://schema.org/encodingFormat encodingFormat} can be used. Geospatial, AR/VR, artistic/animation, gaming, engineering and scientific content can all be represented using {@link http://schema.org/3DModel 3DModel}. */
/** A 3D model represents some kind of 3D content, which may have {@link http://schema.org/encoding encoding}s in one or more {@link http://schema.org/MediaObject MediaObject}s. Many 3D formats are available (e.g. see {@link https://en.wikipedia.org/wiki/Category:3D_graphics_file_formats Wikipedia}); specific encoding formats can be represented using the {@link http://schema.org/encodingFormat encodingFormat} property applied to the relevant {@link http://schema.org/MediaObject MediaObject}. For thecase of a single file published after Zip compression, the convention of appending '+zip' to the {@link http://schema.org/encodingFormat encodingFormat} can be used. Geospatial, AR/VR, artistic/animation, gaming, engineering and scientific content can all be represented using {@link http://schema.org/3DModel 3DModel}. */
export declare type _3DModel = {
export declare type _3DModel = {
"@type": "3DModel";
"@type": "3DModel";
} & _3DModelBase;
} & _3DModelBase;
declare type AboutPageBase = WebPageBase;
declare type AboutPageBase = WebPageBase;
/** Web page type: About page. */
/** Web page type: About page. */
export declare type AboutPage = {
export declare type AboutPage = {
"@type": "AboutPage";
"@type": "AboutPage";
} & AboutPageBase;
} & AboutPageBase;
declare type AcceptActionBase = AllocateActionBase;
declare type AcceptActionBase = AllocateActionBase;
/**
/**
* The act of committing to/adopting an object.
* The act of committing to/adopting an object.
*
*
* Related actions:
* Related actions:
*
*
* - {@link http://schema.org/RejectAction RejectAction}: The antonym of AcceptAction.
* - {@link http://schema.org/RejectAction RejectAction}: The antonym of AcceptAction.
*/
*/
export declare type AcceptAction = {
export declare type AcceptAction = {
"@type": "AcceptAction";
"@type": "AcceptAction";
} & AcceptActionBase;
} & AcceptActionBase;
declare type AccommodationBase = PlaceBase & {
declare type AccommodationBase = PlaceBase & {
/** Category of an {@link http://schema.org/Accommodation Accommodation}, following real estate conventions e.g. RESO (see {@link https://ddwiki.reso.org/display/DDW17/PropertySubType+Field PropertySubType}, and {@link https://ddwiki.reso.org/display/DDW17/PropertyType+Field PropertyType} fields for suggested values). */
/** Category of an {@link http://schema.org/Accommodation Accommodation}, following real estate conventions e.g. RESO (see {@link https://ddwiki.reso.org/display/DDW17/PropertySubType+Field PropertySubType}, and {@link https://ddwiki.reso.org/display/DDW17/PropertyType+Field PropertyType} fields for suggested values). */
"accommodationCategory"?: Text | readonly Text[];
"accommodationCategory"?: Text | readonly Text[];
/** A floorplan of some {@link http://schema.org/Accommodation Accommodation}. */
/** A floorplan of some {@link http://schema.org/Accommodation Accommodation}. */
"accommodationFloorPlan"?: FloorPlan | readonly FloorPlan[];
"accommodationFloorPlan"?: FloorPlan | readonly FloorPlan[];
/** 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. */
/** 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. */
"amenityFeature"?: LocationFeatureSpecification | readonly LocationFeatureSpecification[];
"amenityFeature"?: LocationFeatureSpecification | readonly LocationFeatureSpecification[];
/** The floor level for an {@link http://schema.org/Accommodation Accommodation} in a multi-storey building. Since counting systems {@link https://en.wikipedia.org/wiki/Storey#Consecutive_number_floor_designations vary internationally}, the local system should be used where possible. */
/** The floor level for an {@link http://schema.org/Accommodation Accommodation} in a multi-storey building. Since counting systems {@link https://en.wikipedia.org/wiki/Storey#Consecutive_number_floor_designations vary internationally}, the local system should be used where possible. */
"floorLevel"?: Text | readonly Text[];
"floorLevel"?: Text | readonly Text[];
/** 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 */
/** 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 */
"floorSize"?: QuantitativeValue | readonly QuantitativeValue[];
"floorSize"?: QuantitativeValue | readonly QuantitativeValue[];
/** Length of the lease for some {@link http://schema.org/Accommodation Accommodation}, either particular to some {@link http://schema.org/Offer Offer} or in some cases intrinsic to the property. */
/** Length of the lease for some {@link http://schema.org/Accommodation Accommodation}, either particular to some {@link http://schema.org/Offer Offer} or in some cases intrinsic to the property. */
"leaseLength"?: (Duration | QuantitativeValue) | readonly (Duration | QuantitativeValue)[];
"leaseLength"?: (Duration | QuantitativeValue) | readonly (Duration | QuantitativeValue)[];
/** The total integer number of bathrooms in a some {@link http://schema.org/Accommodation Accommodation}, following real estate conventions as {@link https://ddwiki.reso.org/display/DDW17/BathroomsTotalInteger+Field documented in RESO}: "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 {@link http://schema.org/numberOfRooms numberOfRooms}. */
/** The total integer number of bathrooms in a some {@link http://schema.org/Accommodation Accommodation}, following real estate conventions as {@link https://ddwiki.reso.org/display/DDW17/BathroomsTotalInteger+Field documented in RESO}: "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 {@link http://schema.org/numberOfRooms numberOfRooms}. */
"numberOfBathroomsTotal"?: Integer | readonly Integer[];
"numberOfBathroomsTotal"?: Integer | readonly Integer[];
/** The total integer number of bedrooms in a some {@link http://schema.org/Accommodation Accommodation}, {@link http://schema.org/ApartmentComplex ApartmentComplex} or {@link http://schema.org/FloorPlan FloorPlan}. */
"numberOfBedrooms"?: (Number | QuantitativeValue) | readonly (Number | QuantitativeValue)[];
/** Number of full bathrooms - The total number of full and \u00BE bathrooms in an {@link http://schema.org/Accommodation Accommodation}. This corresponds to the {@link https://ddwiki.reso.org/display/DDW17/BathroomsFull+Field BathroomsFull field in RESO}. */
/** Number of full bathrooms - The total number of full and \u00BE bathrooms in an {@link http://schema.org/Accommodation Accommodation}. This corresponds to the {@link https://ddwiki.reso.org/display/DDW17/BathroomsFull+Field BathroomsFull field in RESO}. */
"numberOfFullBathrooms"?: Number | readonly Number[];
"numberOfFullBathrooms"?: Number | readonly Number[];
/** Number of partial bathrooms - The total number of half and \u00BC bathrooms in an {@link http://schema.org/Accommodation Accommodation}. This corresponds to the {@link https://ddwiki.reso.org/display/DDW17/BathroomsPartial+Field BathroomsPartial field in RESO}. */
/** Number of partial bathrooms - The total number of half and \u00BC bathrooms in an {@link http://schema.org/Accommodation Accommodation}. This corresponds to the {@link https://ddwiki.reso.org/display/DDW17/BathroomsPartial+Field BathroomsPartial field in RESO}. */
"numberOfPartialBathrooms"?: Number | readonly Number[];
"numberOfPartialBathrooms"?: Number | readonly Number[];
/** 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. */
/** 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. */
"numberOfRooms"?: (Number | QuantitativeValue) | readonly (Number | QuantitativeValue)[];
"numberOfRooms"?: (Number | QuantitativeValue) | readonly (Number | QuantitativeValue)[];
/** Indications regarding the permitted usage of the accommodation. */
/** Indications regarding the permitted usage of the accommodation. */
"permittedUsage"?: Text | readonly Text[];
"permittedUsage"?: Text | readonly Text[];
/** Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value. */
/** Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value. */
"petsAllowed"?: (Boolean | Text) | readonly (Boolean | Text)[];
"petsAllowed"?: (Boolean | Text) | readonly (Boolean | Text)[];
/** A page providing information on how to book a tour of some {@link http://schema.org/Place Place}, such as an {@link http://schema.org/Accommodation Accommodation} or {@link http://schema.org/ApartmentComplex ApartmentComplex} in a real estate setting, as well as other kinds of tours as appropriate. */
"tourBookingPage"?: URL | readonly URL[];
/** The year an {@link http://schema.org/Accommodation Accommodation} was constructed. This corresponds to the {@link https://ddwiki.reso.org/display/DDW17/YearBuilt+Field YearBuilt field in RESO}. */
/** The year an {@link http://schema.org/Accommodation Accommodation} was constructed. This corresponds to the {@link https://ddwiki.reso.org/display/DDW17/YearBuilt+Field YearBuilt field in RESO}. */
"yearBuilt"?: Number | readonly Number[];
"yearBuilt"?: Number | readonly Number[];
};
};
/**
/**
* An accommodation is a place that can accommodate human beings, e.g. a hotel room, a camping pitch, or a meeting room. Many accommodations are for overnight stays, but this is not a mandatory requirement.For more specific types of accommodations not defined in schema.org, one can use additionalType with external vocabularies.
* An accommodation is a place that can accommodate human beings, e.g. a hotel room, a camping pitch, or a meeting room. Many accommodations are for overnight stays, but this is not a mandatory requirement.For more specific types of accommodations not defined in schema.org, one can use additionalType with external vocabularies.
*
*
* See also the {@link /docs/hotels.html dedicated document on the use of schema.org for marking up hotels and other forms of accommodations}.
* See also the {@link /docs/hotels.html dedicated document on the use of schema.org for marking up hotels and other forms of accommodations}.
*/
*/
export declare type Accommodation = ({
export declare type Accommodation = ({
"@type": "Accommodation";
"@type": "Accommodation";
} & AccommodationBase) | (Apartment | CampingPitch | House | Room | Suite | string);
} & AccommodationBase) | (Apartment | CampingPitch | House | Room | Suite | string);
declare type AccountingServiceBase = FinancialServiceBase;
declare type AccountingServiceBase = FinancialServiceBase;
/**
/**
* Accountancy business.
* Accountancy business.
*
*
* As a {@link http://schema.org/LocalBusiness LocalBusiness} it can be described as a {@link http://schema.org/provider provider} of one or more {@link http://schema.org/Service Service}(s).
* As a {@link http://schema.org/LocalBusiness LocalBusiness} it can be described as a {@link http://schema.org/provider provider} of one or more {@link http://schema.org/Service Service}(s).
*/
*/
export declare type AccountingService = ({
export declare type AccountingService = ({
"@type": "AccountingService";
"@type": "AccountingService";
} & AccountingServiceBase) | string;
} & AccountingServiceBase) | string;
declare type AchieveActionBase = ActionBase;
declare type AchieveActionBase = ActionBase;
/** The act of accomplishing something via previous efforts. It is an instantaneous action rather than an ongoing process. */
/** The act of accomplishing something via previous efforts. It is an instantaneous action rather than an ongoing process. */
export declare type AchieveAction = ({
export declare type AchieveAction = ({
"@type": "AchieveAction";
"@type": "AchieveAction";
} & AchieveActionBase) | (LoseAction | TieAction | WinAction);
} & AchieveActionBase) | (LoseAction | TieAction | WinAction);
declare type ActionBase = ThingBase & {
declare type ActionBase = ThingBase & {
/** Indicates the current disposition of the Action. */
/** Indicates the current disposition of the Action. */
"actionStatus"?: ActionStatusType | readonly ActionStatusType[];
"actionStatus"?: ActionStatusType | readonly ActionStatusType[];
/** The direct performer or driver of the action (animate or inanimate). e.g. _John_ wrote a book. */
/** The direct performer or driver of the action (animate or inanimate). e.g. _John_ wrote a book. */
"agent"?: (Organization | Person) | readonly (Organization | Person)[];
"agent"?: (Organization | Person) | readonly (Organization | Person)[];
/**
/**
* 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.
* 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.
* Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.
*/
*/
"endTime"?: (DateTime | Time) | readonly (DateTime | Time)[];
"endTime"?: (DateTime | Time) | readonly (DateTime | Time)[];
/** For failed actions, more information on the cause of the failure. */
/** For failed actions, more information on the cause of the failure. */
"error"?: Thing | readonly Thing[];
"error"?: Thing | readonly Thing[];
/** The object that helped the agent perform the action. e.g. John wrote a book with _a pen_. */
/** The object that helped the agent perform the action. e.g. John wrote a book with _a pen_. */
"instrument"?: Thing | readonly Thing[];
"instrument"?: Thing | readonly Thing[];
/** The location of for example where the event is happening, an organization is located, or where an action takes place. */
/** The location of for example where the event is happening, an organization is located, or where an action takes place. */
"location"?: (Place | PostalAddress | Text) | readonly (Place | PostalAddress | Text)[];
"location"?: (Place | PostalAddress | Text | VirtualLocation) | readonly (Place | PostalAddress | Text | VirtualLocation)[];
/** 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_. */
/** 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_. */
"object"?: Thing | readonly Thing[];
"object"?: Thing | readonly Thing[];
/** Other co-agents that participated in the action indirectly. e.g. John wrote a book with _Steve_. */
/** Other co-agents that participated in the action indirectly. e.g. John wrote a book with _Steve_. */
"participant"?: (Organization | Person) | readonly (Organization | Person)[];
"participant"?: (Organization | Person) | readonly (Organization | Person)[];
/** The result produced in the action. e.g. John wrote _a book_. */
/** The result produced in the action. e.g. John wrote _a book_. */
"result"?: Thing | readonly Thing[];
"result"?: Thing | readonly Thing[];
/**
/**
* 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.
* 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.
* 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"?: (DateTime | Time) | readonly (DateTime | Time)[];
"startTime"?: (DateTime | Time) | readonly (DateTime | Time)[];
/** Indicates a target EntryPoint for an Action. */
/** Indicates a target EntryPoint for an Action. */
"target"?: EntryPoint | readonly EntryPoint[];
"target"?: EntryPoint | readonly EntryPoint[];
};
};
/**
/**
* An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument. The execution of the action may produce a result. Specific action sub-type documentation specifies the exact expectation of each argument/role.
* An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument. The execution of the action may produce a result. Specific action sub-type documentation specifies the exact expectation of each argument/role.
*
*
* See also {@link http://blog.schema.org/2014/04/announcing-schemaorg-actions.html blog post} and {@link http://schema.org/docs/actions.html Actions overview document}.
* See also {@link http://blog.schema.org/2014/04/announcing-schemaorg-actions.html blog post} and {@link http://schema.org/docs/actions.html Actions overview document}.
*/
*/
export declare type Action = ({
export declare type Action = ({
"@type": "Action";
"@type": "Action";
} & ActionBase) | (AchieveAction | AssessAction | ConsumeAction | ControlAction | CreateAction | FindAction | InteractAction | MoveAction | OrganizeAction | PlayAction | SearchAction | TradeAction | TransferAction | UpdateAction);
} & ActionBase) | (AchieveAction | AssessAction | ConsumeAction | ControlAction | CreateAction | FindAction | InteractAction | MoveAction | OrganizeAction | PlayAction | SearchAction | TradeAction | TransferAction | UpdateAction);
declare type ActionAccessSpecificationBase = IntangibleBase & {
declare type ActionAccessSpecificationBase = IntangibleBase & {
/** The end of the availability of the product or service included in the offer. */
/** The end of the availability of the product or service included in the offer. */
"availabilityEnds"?: (Date | DateTime | Time) | readonly (Date | DateTime | Time)[];
"availabilityEnds"?: (Date | DateTime | Time) | readonly (Date | DateTime | Time)[];
/** The beginning of the availability of the product or service included in the offer. */
/** The beginning of the availability of the product or service included in the offer. */
"availabilityStarts"?: (Date | DateTime | Time) | readonly (Date | DateTime | Time)[];
"availabilityStarts"?: (Date | DateTime | Time) | readonly (Date | DateTime | Time)[];
/** A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. */
/** A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. */
"category"?: (PhysicalActivityCategory | Text | Thing) | readonly (PhysicalActivityCategory | Text | Thing)[];
"category"?: (PhysicalActivityCategory | Text | Thing) | readonly (PhysicalActivityCategory | Text | Thing)[];
/**
/**
* 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.
* 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 {@link http://schema.org/ineligibleRegion ineligibleRegion}.
* See also {@link http://schema.org/ineligibleRegion ineligibleRegion}.
*/
*/
"eligibleRegion"?: (GeoShape | Place | Text) | readonly (GeoShape | Place | Text)[];
"eligibleRegion"?: (GeoShape | Place | Text) | readonly (GeoShape | Place | Text)[];
/** 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. */
/** 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. */
"expectsAcceptanceOf"?: Offer | readonly Offer[];
"expectsAcceptanceOf"?: Offer | readonly Offer[];
/**
/**
* 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.
* 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 {@link http://schema.org/eligibleRegion eligibleRegion}.
* See also {@link http://schema.org/eligibleRegion eligibleRegion}.
*/
*/
"ineligibleRegion"?: (GeoShape | Place | Text) | readonly (GeoShape | Place | Text)[];
"ineligibleRegion"?: (GeoShape | Place | Text) | readonly (GeoShape | Place | Text)[];
/** 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'). */
/** 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'). */
"requiresSubscription"?: (Boolean | MediaSubscription) | readonly (Boolean | MediaSubscription)[];
"requiresSubscription"?: (Boolean | MediaSubscription) | readonly (Boolean | MediaSubscription)[];
};
};
/** A set of requirements that a must be fulfilled in order to perform an Action. */
/** A set of requirements that a must be fulfilled in order to perform an Action. */
export declare type ActionAccessSpecification = {
export declare type ActionAccessSpecification = {
"@type": "ActionAccessSpecification";
"@type": "ActionAccessSpecification";
} & ActionAccessSpecificationBase;
} & ActionAccessSpecificationBase;
declare type ActionStatusTypeBase = EnumerationBase;
declare type ActionStatusTypeBase = EnumerationBase;
/** The status of an Action. */
/** The status of an Action. */
export declare type ActionStatusType = "http://schema.org/ActiveActionStatus" | "http://schema.org/CompletedActionStatus" | "http://schema.org/FailedActionStatus" | "http://schema.org/PotentialActionStatus" | ({
export declare type ActionStatusType = "http://schema.org/ActiveActionStatus" | "http://schema.org/CompletedActionStatus" | "http://schema.org/FailedActionStatus" | "http://schema.org/PotentialActionStatus" | ({
"@type": "ActionStatusType";
"@type": "ActionStatusType";
} & ActionStatusTypeBase);
} & ActionStatusTypeBase);
export declare const ActionStatusType: {
export declare const ActionStatusType: {
/** An in-progress action (e.g, while watching the movie, or driving to a location). */
/** An in-progress action (e.g, while watching the movie, or driving to a location). */
ActiveActionStatus: "http://schema.org/ActiveActionStatus";
ActiveActionStatus: "http://schema.org/ActiveActionStatus";
/** An action that has already taken place. */
/** An action that has already taken place. */
CompletedActionStatus: "http://schema.org/CompletedActionStatus";
CompletedActionStatus: "http://schema.org/CompletedActionStatus";
/** An action that failed to complete. The action's error property and the HTTP return code contain more information about the failure. */
/** An action that failed to complete. The action's error property and the HTTP return code contain more information about the failure. */
FailedActionStatus: "http://schema.org/FailedActionStatus";
FailedActionStatus: "http://schema.org/FailedActionStatus";
/** A description of an action that is supported. */
/** A description of an action that is supported. */
PotentialActionStatus: "http://schema.org/PotentialActionStatus";
PotentialActionStatus: "http://schema.org/PotentialActionStatus";
};
};
declare type ActivateActionBase = ControlActionBase;
declare type ActivateActionBase = ControlActionBase;
/** The act of starting or activating a device or application (e.g. starting a timer or turning on a flashlight). */
/** The act of starting or activating a device or application (e.g. starting a timer or turning on a flashlight). */
export declare type ActivateAction = {
export declare type ActivateAction = {
"@type": "ActivateAction";
"@type": "ActivateAction";
} & ActivateActionBase;
} & ActivateActionBase;
declare type AddActionBase = UpdateActionBase;
declare type AddActionBase = UpdateActionBase;
/** The act of editing by adding an object to a collection. */
/** The act of editing by adding an object to a collection. */
export declare type AddAction = ({
export declare type AddAction = ({
"@type": "AddAction";
"@type": "AddAction";
} & AddActionBase) | InsertAction;
} & AddActionBase) | InsertAction;
declare type AdministrativeAreaBase = PlaceBase;
declare type AdministrativeAreaBase = PlaceBase;
/** A geographical region, typically under the jurisdiction of a particular government. */
/** A geographical region, typically under the jurisdiction of a particular government. */
export declare type AdministrativeArea = ({
export declare type AdministrativeArea = ({
"@type": "AdministrativeArea";
"@type": "AdministrativeArea";
} & AdministrativeAreaBase) | (City | Country | State | string);
} & AdministrativeAreaBase) | (City | Country | State | string);
declare type AdultEntertainmentBase = EntertainmentBusinessBase;
declare type AdultEntertainmentBase = EntertainmentBusinessBase;
/** An adult entertainment establishment. */
/** An adult entertainment establishment. */
export declare type AdultEntertainment = ({
export declare type AdultEntertainment = ({
"@type": "AdultEntertainment";
"@type": "AdultEntertainment";
} & AdultEntertainmentBase) | string;
} & AdultEntertainmentBase) | string;
declare type AdvertiserContentArticleBase = ArticleBase;
declare type AdvertiserContentArticleBase = ArticleBase;
/** An {@link http://schema.org/Article Article} that an external entity has paid to place or to produce to its specifications. Includes {@link https://en.wikipedia.org/wiki/Advertorial advertorials}, sponsored content, native advertising and other paid content. */
/** An {@link http://schema.org/Article Article} that an external entity has paid to place or to produce to its specifications. Includes {@link https://en.wikipedia.org/wiki/Advertorial advertorials}, sponsored content, native advertising and other paid content. */
export declare type AdvertiserContentArticle = {
export declare type AdvertiserContentArticle = {
"@type": "AdvertiserContentArticle";
"@type": "AdvertiserContentArticle";
} & AdvertiserContentArticleBase;
} & AdvertiserContentArticleBase;
declare type AggregateOfferBase = OfferBase & {
declare type AggregateOfferBase = OfferBase & {
/**
/**
* The highest price of all offers available.
* The highest price of all offers available.
*
*
* Usage guidelines:
* Usage guidelines:
*
*
* - Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.
* - 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.
* - Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
*/
*/
"highPrice"?: (Number | Text) | readonly (Number | Text)[];
"highPrice"?: (Number | Text) | readonly (Number | Text)[];
/**
/**
* The lowest price of all offers available.
* The lowest price of all offers available.
*
*
* Usage guidelines:
* Usage guidelines:
*
*
* - Use values from 0123456789 (Unicode 'DIGIT ZERO' (U+0030) to 'DIGIT NINE' (U+0039)) rather than superficially similiar Unicode symbols.
* - 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.
* - Use '.' (Unicode 'FULL STOP' (U+002E)) rather than ',' to indicate a decimal point. Avoid using these symbols as a readability separator.
*/
*/
"lowPrice"?: (Number | Text) | readonly (Number | Text)[];
"lowPrice"?: (Number | Text) | readonly (Number | Text)[];
/** The number of offers for the product. */
/** The number of offers for the product. */
"offerCount"?: Integer | readonly Integer[];
"offerCount"?: Integer | readonly Integer[];
/** An offer to provide this item&#x2014;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 {@link http://schema.org/businessFunction businessFunction} to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a {@link http://schema.org/Demand 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. */
/** An offer to provide this item&#x2014;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 {@link http://schema.org/businessFunction businessFunction} to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a {@link http://schema.org/Demand 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. */
"offers"?: (Demand | Offer) | readonly (Demand | Offer)[];
"offers"?: (Demand | Offer) | readonly (Demand | Offer)[];
};
};
/**
/**
* When a single product is associated with multiple offers (for example, the same pair of shoes is offered by different merchants), then AggregateOffer can be used.
* When a single product is associated with multiple offers (for example, the same pair of shoes is offered by different merchants), then AggregateOffer can be used.
*
*
* Note: AggregateOffers are normally expected to associate multiple offers that all share the same defined {@link http://schema.org/businessFunction businessFunction} value, or default to http://purl.org/goodrelations/v1#Sell if businessFunction is not explicitly defined.
* Note: AggregateOffers are normally expected to associate multiple offers that all share the same defined {@link http://schema.org/businessFunction businessFunction} value, or default to http://purl.org/goodrelations/v1#Sell if businessFunction is not explicitly defined.
*/
*/
export declare type AggregateOffer = {
export declare type AggregateOffer = {
"@type": "AggregateOffer";
"@type": "AggregateOffer";
} & AggregateOfferBase;
} & AggregateOfferBase;
declare type AggregateRatingBase = RatingBase & {
declare type AggregateRatingBase = RatingBase & {
/** The item that is being reviewed/rated. */
/** The item that is being reviewed/rated. */
"itemReviewed"?: Thing | readonly Thing[];
"itemReviewed"?: Thing | readonly Thing[];
/** The count of total number of ratings. */
/** The count of total number of ratings. */
"ratingCount"?: Integer | readonly Integer[];
"ratingCount"?: Integer | readonly Integer[];
/** The count of total number of reviews. */
/** The count of total number of reviews. */
"reviewCount"?: Integer | readonly Integer[];
"reviewCount"?: Integer | readonly Integer[];
};
};
/** The average rating based on multiple ratings or reviews. */
/** The average rating based on multiple ratings or reviews. */
export declare type AggregateRating = ({
export declare type AggregateRating = ({
"@type": "AggregateRating";
"@type": "AggregateRating";
} & AggregateRatingBase) | EmployerAggregateRating;
} & AggregateRatingBase) | EmployerAggregateRating;
declare type AgreeActionBase = ReactActionBase;
declare type AgreeActionBase = ReactActionBase;
/** The act of expressing a consistency of opinion with the object. An agent agrees to/about an object (a proposition, topic or theme) with participants. */
/** The act of expressing a consistency of opinion with the object. An agent agrees to/about an object (a proposition, topic or theme) with participants. */
export declare type AgreeAction = {
export declare type AgreeAction = {
"@type": "AgreeAction";
"@type": "AgreeAction";
} & AgreeActionBase;
} & AgreeActionBase;
declare type AirlineBase = OrganizationBase & {
declare type AirlineBase = OrganizationBase & {
/** The type of boarding policy used by the airline (e.g. zone-based or group-based). */
/** The type of boarding policy used by the airline (e.g. zone-based or group-based). */
"boardingPolicy"?: BoardingPolicyType | readonly BoardingPolicyType[];
"boardingPolicy"?: BoardingPolicyType | readonly BoardingPolicyType[];
/** IATA identifier for an airline or airport. */
/** IATA identifier for an airline or airport. */
"iataCode"?: Text | readonly Text[];
"iataCode"?: Text | readonly Text[];
};
};
/** An organization that provides flights for passengers. */
/** An organization that provides flights for passengers. */
export declare type Airline = ({
export declare type Airline = ({
"@type": "Airline";
"@type": "Airline";
} & AirlineBase) | string;
} & AirlineBase) | string;
declare type AirportBase = CivicStructureBase & {
declare type AirportBase = CivicStructureBase & {
/** IATA identifier for an airline or airport. */
/** IATA identifier for an airline or airport. */
"iataCode"?: Text | readonly Text[];
"iataCode"?: Text | readonly Text[];
/** ICAO identifier for an airport. */
/** ICAO identifier for an airport. */
"icaoCode"?: Text | readonly Text[];
"icaoCode"?: Text | readonly Text[];
};
};
/** An airport. */
/** An airport. */
export declare type Airport = ({
export declare type Airport = ({
"@type": "Airport";
"@type": "Airport";
} & AirportBase) | string;
} & AirportBase) | string;
declare type AlignmentObjectBase = IntangibleBase & {
declare type AlignmentObjectBase = IntangibleBase & {
/** A category of alignment between the learning resource and the framework node. Recommended values include: 'assesses', 'teaches', 'requires', 'textComplexity', 'readingLevel', 'educationalSubject', and 'educationalLevel'. */
/** A category of alignment between the learning resource and the framework node. Recommended values include: 'assesses', 'teaches', 'requires', 'textComplexity', 'readingLevel', 'educationalSubject', and 'educationalLevel'. */
"alignmentType"?: Text | readonly Text[];
"alignmentType"?: Text | readonly Text[];
/** The framework to which the resource being described is aligned. */
/** The framework to which the resource being described is aligned. */
"educationalFramework"?: Text | readonly Text[];
"educationalFramework"?: Text | readonly Text[];
/** The description of a node in an established educational framework. */
/** The description of a node in an established educational framework. */
"targetDescription"?: Text | readonly Text[];
"targetDescription"?: Text | readonly Text[];
/** The name of a node in an established educational framework. */
/** The name of a node in an established educational framework. */
"targetName"?: Text | readonly Text[];
"targetName"?: Text | readonly Text[];
/** The URL of a node in an established educational framework. */
/** The URL of a node in an established educational framework. */
"targetUrl"?: URL | readonly URL[];
"targetUrl"?: URL | readonly URL[];
};
};
/** An intangible item that describes an alignment between a learning resource and a node in an educational framework. */
/** An intangible item that describes an alignment between a learning resource and a node in an educational framework. */
export declare type AlignmentObject = {
export declare type AlignmentObject = {
"@type": "AlignmentObject";
"@type": "AlignmentObject";
} & AlignmentObjectBase;
} & AlignmentObjectBase;
declare type AllocateActionBase = OrganizeActionBase & {
declare type AllocateActionBase = OrganizeActionBase;
/** A goal towards an action is taken. Can be concrete or abstract. */
"purpose"?: (MedicalDevicePurpose | Thing) | readonly (MedicalDevicePurpose | Thing)[];
};
/** The act of organizing tasks/objects/events by associating resources to it. */
/** The act of organizing tasks/objects/events by associating resources to it. */
export declare type AllocateAction = ({
export declare type AllocateAction = ({
"@type": "AllocateAction";
"@type": "AllocateAction";
} & AllocateActionBase) | (AcceptAction | AssignAction | AuthorizeAction | RejectAction);
} & AllocateActionBase) | (AcceptAction | AssignAction | AuthorizeAction | RejectAction);
declare type AMRadioChannelBase = RadioChannelBase;
declare type AMRadioChannelBase = RadioChannelBase;
/** A radio channel that uses AM. */
/** A radio channel that uses AM. */
export declare type AMRadioChannel = {
export declare type AMRadioChannel = {
"@type": "AMRadioChannel";
"@type": "AMRadioChannel";
} & AMRadioChannelBase;
} & AMRadioChannelBase;
declare type AmusementParkBase = EntertainmentBusinessBase;
declare type AmusementParkBase = EntertainmentBusinessBase;
/** An amusement park. */
/** An amusement park. */
export declare type AmusementPark = ({
export declare type AmusementPark = ({
"@type": "AmusementPark";
"@type": "AmusementPark";
} & AmusementParkBase) | string;
} & AmusementParkBase) | string;
declare type AnalysisNewsArticleBase = NewsArticleBase;
declare type AnalysisNewsArticleBase = NewsArticleBase;
/** An AnalysisNewsArticle is a {@link http://schema.org/NewsArticle NewsArticle} that, while based on factual reporting, incorporates the expertise of the author/producer, offering interpretations and conclusions. */
/** An AnalysisNewsArticle is a {@link http://schema.org/NewsArticle NewsArticle} that, while based on factual reporting, incorporates the expertise of the author/producer, offering interpretations and conclusions. */
export declare type AnalysisNewsArticle = {
export declare type AnalysisNewsArticle = {
"@type": "AnalysisNewsArticle";
"@type": "AnalysisNewsArticle";
} & AnalysisNewsArticleBase;
} & AnalysisNewsArticleBase;
declare type AnatomicalStructureBase = MedicalEntityBase & {
declare type AnatomicalStructureBase = MedicalEntityBase & {
/** If applicable, a description of the pathophysiology associated with the anatomical system, including potential abnormal changes in the mechanical, physical, and biochemical functions of the system. */
/** If applicable, a description of the pathophysiology associated with the anatomical system, including potential abnormal changes in the mechanical, physical, and biochemical functions of the system. */
"associatedPathophysiology"?: Text | readonly Text[];
"associatedPathophysiology"?: Text | readonly Text[];
/** Location in the body of the anatomical structure. */
/** Location in the body of the anatomical structure. */
"bodyLocation"?: Text | readonly Text[];
"bodyLocation"?: Text | readonly Text[];
/** Other anatomical structures to which this structure is connected. */
/** Other anatomical structures to which this structure is connected. */
"connectedTo"?: AnatomicalStructure | readonly AnatomicalStructure[];
"connectedTo"?: AnatomicalStructure | readonly AnatomicalStructure[];
/** An image containing a diagram that illustrates the structure and/or its component substructures and/or connections with other structures. */
/** An image containing a diagram that illustrates the structure and/or its component substructures and/or connections with other structures. */
"diagram"?: ImageObject | readonly ImageObject[];
"diagram"?: ImageObject | readonly ImageObject[];
/** Function of the anatomical structure. */
"function"?: Text | readonly Text[];
/** The anatomical or organ system that this structure is part of. */
/** The anatomical or organ system that this structure is part of. */
"partOfSystem"?: AnatomicalSystem | readonly AnatomicalSystem[];
"partOfSystem"?: AnatomicalSystem | readonly AnatomicalSystem[];
/** A medical condition associated with this anatomy. */
/** A medical condition associated with this anatomy. */
"relatedCondition"?: MedicalCondition | readonly MedicalCondition[];
"relatedCondition"?: MedicalCondition | readonly MedicalCondition[];
/** A medical therapy related to this anatomy. */
/** A medical therapy related to this anatomy. */
"relatedTherapy"?: MedicalTherapy | readonly MedicalTherapy[];
"relatedTherapy"?: MedicalTherapy | readonly MedicalTherapy[];
/** Component (sub-)structure(s) that comprise this anatomical structure. */
/** Component (sub-)structure(s) that comprise this anatomical structure. */
"subStructure"?: AnatomicalStructure | readonly AnatomicalStructure[];
"subStructure"?: AnatomicalStructure | readonly AnatomicalStructure[];
};
};
/** Any part of the human body, typically a component of an anatomical system. Organs, tissues, and cells are all anatomical structures. */
/** Any part of the human body, typically a component of an anatomical system. Organs, tissues, and cells are all anatomical structures. */
export declare type AnatomicalStructure = ({
export declare type AnatomicalStructure = ({
"@type": "AnatomicalStructure";
"@type": "AnatomicalStructure";
} & AnatomicalStructureBase) | (Bone | BrainStructure | Joint | Ligament | Muscle | Nerve | Vessel);
} & AnatomicalStructureBase) | (Bone | BrainStructure | Joint | Ligament | Muscle | Nerve | Vessel);
declare type AnatomicalSystemBase = MedicalEntityBase & {
declare type AnatomicalSystemBase = MedicalEntityBase & {
/** If applicable, a description of the pathophysiology associated with the anatomical system, including potential abnormal changes in the mechanical, physical, and biochemical functions of the system. */
/** If applicable, a description of the pathophysiology associated with the anatomical system, including potential abnormal changes in the mechanical, physical, and biochemical functions of the system. */
"associatedPathophysiology"?: Text | readonly Text[];
"associatedPathophysiology"?: Text | readonly Text[];
/** Specifying something physically contained by something else. Typically used here for the underlying anatomical structures, such as organs, that comprise the anatomical system. */
/** Specifying something physically contained by something else. Typically used here for the unde
"comprisedOf"?: (AnatomicalStructure | AnatomicalSystem) | readonly (AnatomicalStructure | AnatomicalSystem)[];
/** A medical condition associated with this anatomy. */
"relatedCondition"?: MedicalCondition | readonly MedicalCondition[];
/** Related anatomical structure(s) that are not part of the system but relate or connect to it, such as vascu