schema-dts 0.7.4 (vs 0.7.1)

Created Diff never expires
12 removals
Words removed73
Total words3229
Words removed (%)2.26
354 lines
36 additions
Words added74
Total words3230
Words added (%)2.29
368 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> = Graph | (T & {
"@context": "https://schema.org";
"@context": "https://schema.org";
};
});
export interface Graph {
"@context": "https://schema.org";
"@graph": readonly Thing[];
}
declare type SchemaValue<T> = T | readonly T[];
declare type SchemaValue<T> = T | readonly T[];
declare type IdReference = {
declare type IdReference = {
/** IRI identifying the canonical address of this object. */
/** IRI identifying the canonical address of this object. */
"@id": string;
"@id": string;
};
};
/** Boolean: True or False. */
/** Boolean: True or False. */
export declare type Boolean = "https://schema.org/False" | "False" | "https://schema.org/True" | "True" | boolean;
export declare type Boolean = "https://schema.org/False" | "False" | "https://schema.org/True" | "True" | boolean;
export declare const Boolean: {
export declare const Boolean: {
/** The boolean value false. */
/**
* The boolean value false.
* @deprecated Please use the literal string "False" instead.
*/
False: "https://schema.org/False";
False: "https://schema.org/False";
/** The boolean value true. */
/**
* The boolean value true.
* @deprecated Please use the literal string "True" instead.
*/
True: "https://schema.org/True";
True: "https://schema.org/True";
};
};
/** 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.
*
*
* 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.
*/
*/
export declare type Number = Float | Integer | number;
export declare type Number = Float | Integer | number;
/** Data type: Text. */
/** Data type: Text. */
export declare type Text = CssSelectorType | PronounceableText | URL | XPathType | string;
export declare type Text = CssSelectorType | PronounceableText | URL | XPathType | string;
/** A point in time recurring on multiple days in the form hh:mm:ss[Z|(+|-)hh:mm] (see {@link http://www.w3.org/TR/xmlschema-2/#time XML schema for details}). */
/** A point in time recurring on multiple days in the form hh:mm:ss[Z|(+|-)hh:mm] (see {@link http://www.w3.org/TR/xmlschema-2/#time XML schema for details}). */
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 = Boolean | Date | DateTime | Number | Text | Time;
export declare type DataType = Boolean | Date | DateTime | Number | Text | Time;
declare type _3DModelBase = MediaObjectBase & {
declare type _3DModelBase = MediaObjectBase & {
/** 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"?: SchemaValue<Boolean>;
"isResizable"?: SchemaValue<Boolean>;
};
};
declare type _3DModelLeaf = {
declare type _3DModelLeaf = {
"@type": "3DModel";
"@type": "3DModel";
} & _3DModelBase;
} & _3DModelBase;
/** A 3D model represents some kind of 3D content, which may have {@link https://schema.org/encoding encoding}s in one or more {@link https://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 https://schema.org/encodingFormat encodingFormat} property applied to the relevant {@link https://schema.org/MediaObject MediaObject}. For thecase of a single file published after Zip compression, the convention of appending '+zip' to the {@link https://schema.org/encodingFormat encodingFormat} can be used. Geospatial, AR/VR, artistic/animation, gaming, engineering and scientific content can all be represented using {@link https://schema.org/3DModel 3DModel}. */
/** A 3D model represents some kind of 3D content, which may have {@link https://schema.org/encoding encoding}s in one or more {@link https://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 https://schema.org/encodingFormat encodingFormat} property applied to the relevant {@link https://schema.org/MediaObject MediaObject}. For thecase of a single file published after Zip compression, the convention of appending '+zip' to the {@link https://schema.org/encodingFormat encodingFormat} can be used. Geospatial, AR/VR, artistic/animation, gaming, engineering and scientific content can all be represented using {@link https://schema.org/3DModel 3DModel}. */
export declare type _3DModel = _3DModelLeaf;
export declare type _3DModel = _3DModelLeaf;
declare type AboutPageLeaf = {
declare type AboutPageLeaf = {
"@type": "AboutPage";
"@type": "AboutPage";
} & WebPageBase;
} & WebPageBase;
/** Web page type: About page. */
/** Web page type: About page. */
export declare type AboutPage = AboutPageLeaf;
export declare type AboutPage = AboutPageLeaf;
declare type AcceptActionLeaf = {
declare type AcceptActionLeaf = {
"@type": "AcceptAction";
"@type": "AcceptAction";
} & ActionBase;
} & ActionBase;
/**
/**
* The act of committing to/adopting an object.
* The act of committing to/adopting an object.
*
*
* Related actions:
* Related actions:
*
*
* - {@link https://schema.org/RejectAction RejectAction}: The antonym of AcceptAction.
* - {@link https://schema.org/RejectAction RejectAction}: The antonym of AcceptAction.
*/
*/
export declare type AcceptAction = AcceptActionLeaf;
export declare type AcceptAction = AcceptActionLeaf;
declare type AccommodationBase = PlaceBase & {
declare type AccommodationBase = PlaceBase & {
/** Category of an {@link https://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 https://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"?: SchemaValue<Text>;
"accommodationCategory"?: SchemaValue<Text>;
/** A floorplan of some {@link https://schema.org/Accommodation Accommodation}. */
/** A floorplan of some {@link https://schema.org/Accommodation Accommodation}. */
"accommodationFloorPlan"?: SchemaValue<FloorPlan | IdReference>;
"accommodationFloorPlan"?: SchemaValue<FloorPlan | IdReference>;
/** 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"?: SchemaValue<LocationFeatureSpecification | IdReference>;
"amenityFeature"?: SchemaValue<LocationFeatureSpecification | IdReference>;
/** The floor level for an {@link https://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 https://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"?: SchemaValue<Text>;
"floorLevel"?: SchemaValue<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"?: SchemaValue<QuantitativeValue | IdReference>;
"floorSize"?: SchemaValue<QuantitativeValue | IdReference>;
/** Length of the lease for some {@link https://schema.org/Accommodation Accommodation}, either particular to some {@link https://schema.org/Offer Offer} or in some cases intrinsic to the property. */
/** Length of the lease for some {@link https://schema.org/Accommodation Accommodation}, either particular to some {@link https://schema.org/Offer Offer} or in some cases intrinsic to the property. */
"leaseLength"?: SchemaValue<Duration | QuantitativeValue | IdReference>;
"leaseLength"?: SchemaValue<Duration | QuantitativeValue | IdReference>;
/** The total integer number of bathrooms in a some {@link https://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 https://schema.org/numberOfRooms numberOfRooms}. */
/** The total integer number of bathrooms in a some {@link https://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 https://schema.org/numberOfRooms numberOfRooms}. */
"numberOfBathroomsTotal"?: SchemaValue<Integer>;
"numberOfBathroomsTotal"?: SchemaValue<Integer>;
/** The total integer number of bedrooms in a some {@link https://schema.org/Accommodation Accommodation}, {@link https://schema.org/ApartmentComplex ApartmentComplex} or {@link https://schema.org/FloorPlan FloorPlan}. */
/** The total integer number of bedrooms in a some {@link https://schema.org/Accommodation Accommodation}, {@link https://schema.org/ApartmentComplex ApartmentComplex} or {@link https://schema.org/FloorPlan FloorPlan}. */
"numberOfBedrooms"?: SchemaValue<Number | QuantitativeValue | IdReference>;
"numberOfBedrooms"?: SchemaValue<Number | QuantitativeValue | IdReference>;
/** Number of full bathrooms - The total number of full and \u00BE bathrooms in an {@link https://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 https://schema.org/Accommodation Accommodation}. This corresponds to the {@link https://ddwiki.reso.org/display/DDW17/BathroomsFull+Field BathroomsFull field in RESO}. */
"numberOfFullBathrooms"?: SchemaValue<Number>;
"numberOfFullBathrooms"?: SchemaValue<Number>;
/** Number of partial bathrooms - The total number of half and \u00BC bathrooms in an {@link https://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 https://schema.org/Accommodation Accommodation}. This corresponds to the {@link https://ddwiki.reso.org/display/DDW17/BathroomsPartial+Field BathroomsPartial field in RESO}. */
"numberOfPartialBathrooms"?: SchemaValue<Number>;
"numberOfPartialBathrooms"?: SchemaValue<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"?: SchemaValue<Number | QuantitativeValue | IdReference>;
"numberOfRooms"?: SchemaValue<Number | QuantitativeValue | IdReference>;
/** Indications regarding the permitted usage of the accommodation. */
/** Indications regarding the permitted usage of the accommodation. */
"permittedUsage"?: SchemaValue<Text>;
"permittedUsage"?: SchemaValue<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"?: SchemaValue<Boolean | Text>;
"petsAllowed"?: SchemaValue<Boolean | Text>;
/** A page providing information on how to book a tour of some {@link https://schema.org/Place Place}, such as an {@link https://schema.org/Accommodation Accommodation} or {@link https://schema.org/ApartmentComplex ApartmentComplex} in a real estate setting, as well as other kinds of tours as appropriate. */
/** A page providing information on how to book a tour of some {@link https://schema.org/Place Place}, such as an {@link https://schema.org/Accommodation Accommodation} or {@link https://schema.org/ApartmentComplex ApartmentComplex} in a real estate setting, as well as other kinds of tours as appropriate. */
"tourBookingPage"?: SchemaValue<URL>;
"tourBookingPage"?: SchemaValue<URL>;
/** The year an {@link https://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 https://schema.org/Accommodation Accommodation} was constructed. This corresponds to the {@link https://ddwiki.reso.org/display/DDW17/YearBuilt+Field YearBuilt field in RESO}. */
"yearBuilt"?: SchemaValue<Number>;
"yearBuilt"?: SchemaValue<Number>;
};
};
declare type AccommodationLeaf = {
declare type AccommodationLeaf = {
"@type": "Accommodation";
"@type": "Accommodation";
} & AccommodationBase;
} & AccommodationBase;
/**
/**
* 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 = AccommodationLeaf | Apartment | CampingPitch | House | Room | Suite | string;
export declare type Accommodation = AccommodationLeaf | Apartment | CampingPitch | House | Room | Suite | string;
declare type AccountingServiceLeaf = {
declare type AccountingServiceLeaf = {
"@type": "AccountingService";
"@type": "AccountingService";
} & FinancialServiceBase;
} & FinancialServiceBase;
/**
/**
* Accountancy business.
* Accountancy business.
*
*
* As a {@link https://schema.org/LocalBusiness LocalBusiness} it can be described as a {@link https://schema.org/provider provider} of one or more {@link https://schema.org/Service Service}(s).
* As a {@link https://schema.org/LocalBusiness LocalBusiness} it can be described as a {@link https://schema.org/provider provider} of one or more {@link https://schema.org/Service Service}(s).
*/
*/
export declare type AccountingService = AccountingServiceLeaf | string;
export declare type AccountingService = AccountingServiceLeaf | string;
declare type AchieveActionLeaf = {
declare type AchieveActionLeaf = {
"@type": "AchieveAction";
"@type": "AchieveAction";
} & ActionBase;
} & 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 = AchieveActionLeaf | LoseAction | TieAction | WinAction;
export declare type AchieveAction = AchieveActionLeaf | 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"?: SchemaValue<ActionStatusType | IdReference>;
"actionStatus"?: SchemaValue<ActionStatusType | IdReference>;
/** 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"?: SchemaValue<Organization | Person | IdReference>;
"agent"?: SchemaValue<Organization | Person | IdReference>;
/**
/**
* 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"?: SchemaValue<DateTime | Time>;
"endTime"?: SchemaValue<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"?: SchemaValue<Thing | IdReference>;
"error"?: SchemaValue<Thing | IdReference>;
/** 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"?: SchemaValue<Thing | IdReference>;
"instrument"?: SchemaValue<Thing | IdReference>;
/** 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"?: SchemaValue<Place | PostalAddress | Text | VirtualLocation | IdReference>;
"location"?: SchemaValue<Place | PostalAddress | Text | VirtualLocation | IdReference>;
/** 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"?: SchemaValue<Thing | IdReference>;
"object"?: SchemaValue<Thing | IdReference>;
/** 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"?: SchemaValue<Organization | Person | IdReference>;
"participant"?: SchemaValue<Organization | Person | IdReference>;
/** 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"?: SchemaValue<Thing | IdReference>;
"result"?: SchemaValue<Thing | IdReference>;
/**
/**
* 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"?: SchemaValue<DateTime | Time>;
"startTime"?: SchemaValue<DateTime | Time>;
/** Indicates a target EntryPoint for an Action. */
/** Indicates a target EntryPoint for an Action. */
"target"?: SchemaValue<EntryPoint | IdReference>;
"target"?: SchemaValue<EntryPoint | IdReference>;
};
};
declare type ActionLeaf = {
declare type ActionLeaf = {
"@type": "Action";
"@type": "Action";
} & ActionBase;
} & ActionBase;
/**
/**
* 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 https://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 https://schema.org/docs/actions.html Actions overview document}.
*/
*/
export declare type Action = ActionLeaf | AchieveAction | AssessAction | ConsumeAction | ControlAction | CreateAction | FindAction | InteractAction | MoveAction | OrganizeAction | PlayAction | SearchAction | TradeAction | TransferAction | UpdateAction;
export declare type Action = ActionLeaf | AchieveAction | AssessAction | ConsumeAction | ControlAction | CreateAction | FindAction | InteractAction | MoveAction | OrganizeAction | PlayAction | SearchAction | TradeAction | TransferAction | UpdateAction;
declare type ActionAccessSpecificationBase = ThingBase & {
declare type ActionAccessSpecificationBase = ThingBase & {
/** 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"?: SchemaValue<Date | DateTime | Time>;
"availabilityEnds"?: SchemaValue<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"?: SchemaValue<Date | DateTime | Time>;
"availabilityStarts"?: SchemaValue<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"?: SchemaValue<PhysicalActivityCategory | Text | Thing | URL | IdReference>;
"category"?: SchemaValue<PhysicalActivityCategory | Text | Thing | URL | IdReference>;
/**
/**
* 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 https://schema.org/ineligibleRegion ineligibleRegion}.
* See also {@link https://schema.org/ineligibleRegion ineligibleRegion}.
*/
*/
"eligibleRegion"?: SchemaValue<GeoShape | Place | Text | IdReference>;
"eligibleRegion"?: SchemaValue<GeoShape | Place | Text | IdReference>;
/** 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"?: SchemaValue<Offer | IdReference>;
"expectsAcceptanceOf"?: SchemaValue<Offer | IdReference>;
/**
/**
* 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 https://schema.org/eligibleRegion eligibleRegion}.
* See also {@link https://schema.org/eligibleRegion eligibleRegion}.
*/
*/
"ineligibleRegion"?: SchemaValue<GeoShape | Place | Text | IdReference>;
"ineligibleRegion"?: SchemaValue<GeoShape | Place | Text | IdReference>;
/** 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"?: SchemaValue<Boolean | MediaSubscription | IdReference>;
"requiresSubscription"?: SchemaValue<Boolean | MediaSubscription | IdReference>;
};
};
declare type ActionAccessSpecificationLeaf = {
declare type ActionAccessSpecificationLeaf = {
"@type": "ActionAccessSpecification";
"@type": "ActionAccessSpecification";
} & ActionAccessSpecificationBase;
} & ActionAccessSpecificationBase;
/** 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 = ActionAccessSpecificationLeaf;
export declare type ActionAccessSpecification = ActionAccessSpecificationLeaf;
declare type ActionStatusTypeLeaf = {
declare type ActionStatusTypeLeaf = {
"@type": "ActionStatusType";
"@type": "ActionStatusType";
} & EnumerationBase;
} & EnumerationBase;
/** The status of an Action. */
/** The status of an Action. */
export declare type ActionStatusType = "https://schema.org/ActiveActionStatus" | "ActiveActionStatus" | "https://schema.org/CompletedActionStatus" | "CompletedActionStatus" | "https://schema.org/FailedActionStatus" | "FailedActionStatus" | "https://schema.org/PotentialActionStatus" | "PotentialActionStatus" | ActionStatusTypeLeaf;
export declare type ActionStatusType = "https://schema.org/ActiveActionStatus" | "ActiveActionStatus" | "https://schema.org/CompletedActionStatus" | "CompletedActionStatus" | "https://schema.org/FailedActionStatus" | "FailedActionStatus" | "https://schema.org/PotentialActionStatus" | "PotentialActionStatus" | ActionStatusTypeLeaf;
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).
* @deprecated Please use the literal string "ActiveActionStatus" instead.
*/
ActiveActionStatus: "https://schema.org/ActiveActionStatus";
ActiveActionStatus: "https://schema.org/ActiveActionStatus";
/** An action that has already taken place. */
/**
* An action that has already taken place.
* @deprecated Please use the literal string "CompletedActionStatus" instead.
*/
CompletedActionStatus: "https://schema.org/CompletedActionStatus";
CompletedActionStatus: "https://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.
* @deprecated Please use the literal string "FailedActionStatus" instead.
*/
FailedActionStatus: "https://schema.org/FailedActionStatus";
FailedActionStatus: "https://schema.org/FailedActionStatus";
/** A description of an action that is supported. */
/**
* A description of an action that is supported.
* @deprecated Please use the literal string "PotentialActionStatus" instead.
*/
PotentialActionStatus: "https://schema.org/PotentialActionStatus";
PotentialActionStatus: "https://schema.org/PotentialActionStatus";
};
};
declare type ActivateActionLeaf = {
declare type ActivateActionLeaf = {
"@type": "ActivateAction";
"@type": "ActivateAction";
} & ActionBase;
} & ActionBase;
/** 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 = ActivateActionLeaf;
export declare type ActivateAction = ActivateActionLeaf;
declare type AddActionLeaf = {
declare type AddActionLeaf = {
"@type": "AddAction";
"@type": "AddAction";
} & UpdateActionBase;
} & 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 = AddActionLeaf | InsertAction;
export declare type AddAction = AddActionLeaf | InsertAction;
declare type AdministrativeAreaLeaf = {
declare type AdministrativeAreaLeaf = {
"@type": "AdministrativeArea";
"@type": "AdministrativeArea";
} & PlaceBase;
} & 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 = AdministrativeAreaLeaf | City | Country | SchoolDistrict | State | string;
export declare type AdministrativeArea = AdministrativeAreaLeaf | City | Country | SchoolDistrict | State | string;
declare type AdultEntertainmentLeaf = {
declare type AdultEntertainmentLeaf = {
"@type": "AdultEntertainment";
"@type": "AdultEntertainment";
} & LocalBusinessBase;
} & LocalBusinessBase;
/** An adult entertainment establishment. */
/** An adult entertainment establishment. */
export declare type AdultEntertainment = AdultEntertainmentLeaf | string;
export declare type AdultEntertainment = AdultEntertainmentLeaf | string;
declare type AdvertiserContentArticleLeaf = {
declare type AdvertiserContentArticleLeaf = {
"@type": "AdvertiserContentArticle";
"@type": "AdvertiserContentArticle";
} & ArticleBase;
} & ArticleBase;
/** An {@link https://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 https://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 = AdvertiserContentArticleLeaf;
export declare type AdvertiserContentArticle = AdvertiserContentArticleLeaf;
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"?: SchemaValue<Number | Text>;
"highPrice"?: SchemaValue<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"?: SchemaValue<Number | Text>;
"lowPrice"?: SchemaValue<Number | Text>;
/** The number of offers for the product. */
/** The number of offers for the product. */
"offerCount"?: SchemaValue<Integer>;
"offerCount"?: SchemaValue<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 https://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 https://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 https://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 https://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"?: SchemaValue<Demand | Offer | IdReference>;
"offers"?: SchemaValue<Demand | Offer | IdReference>;
};
};
declare type AggregateOfferLeaf = {
declare type AggregateOfferLeaf = {
"@type": "AggregateOffer";
"@type": "AggregateOffer";
} & AggregateOfferBase;
} & AggregateOfferBase;
/**
/**
* 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 https://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 https://schema.org/businessFunction businessFunction} value, or default to http://purl.org/goodrelations/v1#Sell if businessFunction is not explicitly defined.
*/
*/
export declare type AggregateOffer = AggregateOfferLeaf;
export declare type AggregateOffer = AggregateOfferLeaf;
declare type AggregateRatingBase = RatingBase & {
declare type AggregateRatingBase = RatingBase & {
/** The item that is being reviewed/rated. */
/** The item that is being reviewed/rated. */
"itemReviewed"?: SchemaValue<Thing | IdReference>;
"itemReviewed"?: SchemaValue<Thing | IdReference>;
/** The count of total number of ratings. */
/** The count of total number of ratings. */
"ratingCount"?: SchemaValue<Integer>;
"ratingCount"?: SchemaValue<Integer>;
/** The count of total number of reviews. */
/** The count of total number of reviews. */
"reviewCount"?: SchemaValue<Integer>;
"reviewCount"?: SchemaValue<Integer>;
};
};
declare type AggregateRatingLeaf = {
declare type AggregateRatingLeaf = {
"@type": "AggregateRating";
"@type": "AggregateRating";
} & AggregateRatingBase;
} & AggregateRatingBase;
/** The average rating based on multiple ratings or reviews. */
/** The average rating based on multiple ratings or reviews. */
export declare type AggregateRating = AggregateRatingLeaf | EmployerAggregateRating;
export declare type AggregateRating = AggregateRatingLeaf | EmployerAggregateRating;
declare type AgreeActionLeaf = {
declare type AgreeActionLeaf = {
"@type": "AgreeAction";
"@type": "AgreeAction";
} & ActionBase;
} & ActionBase;
/** 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 = AgreeActionLeaf;
export declare type AgreeAction = AgreeActionLeaf;
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"?: SchemaValue<BoardingPolicyType | IdReference>;
"boardingPolicy"?: SchemaValue<BoardingPolicyType | IdReference>;
/** IATA identifier for an airline or airport. */
/** IATA identifier for an airline or airport. */
"iataCode"?: SchemaValue<Text>;
"iataCode"?: SchemaValue<Text>;
};
};
declare type AirlineLeaf = {
declare type AirlineLeaf = {
"@type": "Airline";
"@type": "Airline";
} & AirlineBase;
} & AirlineBase;
/** An organization that provides flights for passengers. */
/** An organization that provides flights for passengers. */
export declare type Airline = AirlineLeaf | string;
export declare type Airline = AirlineLeaf | string;
declare type AirportBase = CivicStructureBase & {
declare type AirportBase = CivicStructureBase & {
/** IATA identifier for an airline or airport. */
/** IATA identifier for an airline or airport. */
"iataCode"?: SchemaValue<Text>;
"iataCode"?: SchemaValue<Text>;
/** ICAO identifier for an airport. */
/** ICAO identifier for an airport. */
"icaoCode"?: SchemaValue<Text>;
"icaoCode"?: SchemaValue<Text>;
};
};
declare type AirportLeaf = {
declare type AirportLeaf = {
"@type": "Airport";
"@type": "Airport";
} & AirportBase;
} & AirportBase;
/** An airport. */
/** An airport. */
export declare type Airport = AirportLeaf | string;
export declare type Airport = AirportLeaf | string;
declare type AlignmentObjectBase = ThingBase & {
declare type AlignmentObjectBase = ThingBase & {
/** A category of alignment between the learning resource and the framework node. Recommended values include: 'requires', 'textComplexity', 'readingLevel', and 'educationalSubject'. */
/** A category of alignment between the learning resource and the framework node. Recommended values include: 'requires', 'textComplexity', 'readingLevel', and 'educationalSubject'. */
"alignmentType"?: SchemaValue<Text>;
"alignmentType"?: SchemaValue<Text>;
/** The framework to which the resource being described is aligned. */
/** The framework to which the resource being described is aligned. */
"educationalFramework"?: SchemaValue<Text>;
"educationalFramework"?: SchemaValue<Text>;
/** The description of a node in an established educational framework. */
/** The description of a node in an established educational framework. */
"targetDescription"?: SchemaValue<Text>;
"targetDescription"?: SchemaValue<Text>;
/** The name of a node in an established educational framework. */
/** The name of a node in an established educational framework. */
"targetName"?: SchemaValue<Text>;
"targetName"?: SchemaValue<Text>;
/** The URL of a node in an established educational framework. */
/** The URL of a node in an established educational framework. */
"targetUrl"?: SchemaValue<URL>;
"targetUrl"?: SchemaValue<URL>;
};
};
declare type AlignmentObjectLeaf = {
declare type AlignmentObjectLeaf = {
"@type": "AlignmentObject";
"@type": "AlignmentObject";
} & AlignmentObjectBase;
} & AlignmentObjectBase;
/**
/**
* 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.
*
*
* Should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource {@link https://schema.org/teaches teaches} or {@link https://schema.org/assesses assesses} a competency.
* Should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource {@link https://schema.org/teaches teaches} or {@link https://schema.org/assesses assesses} a competency.
*/
*/
export declare type AlignmentObject = AlignmentObjectLeaf;
export declare type AlignmentObject = AlignmentObjectLeaf;
declare type AllocateActionLeaf = {
declare type AllocateActionLeaf = {
"@type": "AllocateAction";
"@type": "AllocateAction";
} & ActionBase;
} & ActionBase;
/** 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 = AllocateActionLeaf | AcceptAction | AssignAction | AuthorizeAction | RejectAction;
export declare type AllocateAction = AllocateActionLeaf | AcceptAction | AssignAction | AuthorizeAction | RejectAction;
declare type AMRadioChannelLeaf = {
declare type AMRadioChannelLeaf = {
"@type": "AMRadioChannel";
"@type": "AMRadioChannel";
} & BroadcastChannelBase;
} & BroadcastChannelBase;
/** A radio channel that uses AM. */
/** A radio channel that uses AM. */
export declare type AMRadioChannel = AMRadioChannelLeaf;
export declare type AMRadioChannel = AMRadioChannelLeaf;
declare type AmusementParkLeaf = {
declare type AmusementParkLeaf = {
"@type": "AmusementPark";
"@type": "AmusementPark";
} & LocalBusinessBase;
} & LocalBusinessBase;
/** An amusement park. */
/** An amusement park. */
export declare type AmusementPark = AmusementParkLeaf | string;
export declare type AmusementPark = AmusementParkLeaf | string;
declare type AnalysisNewsArticleLeaf = {
declare type AnalysisNewsArticleLeaf = {
"@type": "AnalysisNewsArticle";
"@type": "AnalysisNewsArticle";
} & NewsArticleBase;
} & NewsArticleBase;
/** An AnalysisNewsArticle is a {@link https://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 https://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 = AnalysisNewsArticleLeaf;
export declare type AnalysisNewsArticle = AnalysisNewsArticleLeaf;
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"?: SchemaValue<Text>;
"associatedPathophysiology"?: SchemaValue<Text>;
/** Location in the body of the anatomical structure. */
/** Location in the body of the anatomical structure. */
"bodyLocation"?: SchemaValue<Text>;
"bodyLocation"?: SchemaValue<Text>;
/** Other anatomical structures to which this structure is connected. */
/**
"connectedTo"?: SchemaValue<AnatomicalStructure | IdReference>;
/** An image containing a diagram that illustrates the structure and/or its component substructures and/or connections with other structures. */
"diagram"?: SchemaValue<ImageObject | IdReference>;
/** The anatomical or organ system that this structure is part of. */
"partOfSystem"?: SchemaValue<AnatomicalSystem | IdReference>;
/** A medical condition associated with this anatomy. */
"relatedCondition"?: SchemaValue<MedicalCondition | IdReference>;
/** A medical