schema-dts v1.1.0 (vs 1.0.0)

Created Diff never expires
4 removals
Words removed4
Total words3201
Words removed (%)0.12
314 lines
4 additions
Words added4
Total words3201
Words added (%)0.12
314 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";
};
};
export interface Graph {
export interface Graph {
"@context": "https://schema.org";
"@context": "https://schema.org";
"@graph": readonly Thing[];
"@graph": readonly Thing[];
}
}
declare type SchemaValue<T, TProperty extends string> = T | Role<T, TProperty> | readonly (T | Role<T, TProperty>)[];
declare type SchemaValue<T, TProperty extends string> = T | Role<T, TProperty> | readonly (T | Role<T, TProperty>)[];
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;
/** 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;
interface EmployeeRoleBase extends OrganizationRoleBase {
interface EmployeeRoleBase extends OrganizationRoleBase {
/** The base salary of the job or of an employee in an EmployeeRole. */
/** The base salary of the job or of an employee in an EmployeeRole. */
"baseSalary"?: SchemaValue<MonetaryAmount | Number | PriceSpecification | IdReference, "baseSalary">;
"baseSalary"?: SchemaValue<MonetaryAmount | Number | PriceSpecification | IdReference, "baseSalary">;
/** The currency (coded using {@link http://en.wikipedia.org/wiki/ISO_4217 ISO 4217} ) used for the main salary information in this job posting or for this employee. */
/** The currency (coded using {@link http://en.wikipedia.org/wiki/ISO_4217 ISO 4217} ) used for the main salary information in this job posting or for this employee. */
"salaryCurrency"?: SchemaValue<Text, "salaryCurrency">;
"salaryCurrency"?: SchemaValue<Text, "salaryCurrency">;
}
}
declare type EmployeeRoleLeaf<TContent, TProperty extends string> = EmployeeRoleBase & {
declare type EmployeeRoleLeaf<TContent, TProperty extends string> = EmployeeRoleBase & {
"@type": "EmployeeRole";
"@type": "EmployeeRole";
} & {
} & {
[key in TProperty]: TContent;
[key in TProperty]: TContent;
};
};
/** A subclass of OrganizationRole used to describe employee relationships. */
/** A subclass of OrganizationRole used to describe employee relationships. */
export declare type EmployeeRole<TContent = never, TProperty extends string = never> = EmployeeRoleLeaf<TContent, TProperty>;
export declare type EmployeeRole<TContent = never, TProperty extends string = never> = EmployeeRoleLeaf<TContent, TProperty>;
interface LinkRoleBase extends RoleBase {
interface LinkRoleBase extends RoleBase {
/** The language of the content or performance or used in an action. Please use one of the language codes from the {@link http://tools.ietf.org/html/bcp47 IETF BCP 47 standard}. See also {@link https://schema.org/availableLanguage availableLanguage}. */
/** The language of the content or performance or used in an action. Please use one of the language codes from the {@link http://tools.ietf.org/html/bcp47 IETF BCP 47 standard}. See also {@link https://schema.org/availableLanguage availableLanguage}. */
"inLanguage"?: SchemaValue<Language | Text | IdReference, "inLanguage">;
"inLanguage"?: SchemaValue<Language | Text | IdReference, "inLanguage">;
/** Indicates the relationship type of a Web link. */
/** Indicates the relationship type of a Web link. */
"linkRelationship"?: SchemaValue<Text, "linkRelationship">;
"linkRelationship"?: SchemaValue<Text, "linkRelationship">;
}
}
declare type LinkRoleLeaf<TContent, TProperty extends string> = LinkRoleBase & {
declare type LinkRoleLeaf<TContent, TProperty extends string> = LinkRoleBase & {
"@type": "LinkRole";
"@type": "LinkRole";
} & {
} & {
[key in TProperty]: TContent;
[key in TProperty]: TContent;
};
};
/** A Role that represents a Web link e.g. as expressed via the 'url' property. Its linkRelationship property can indicate URL-based and plain textual link types e.g. those in IANA link registry or others such as 'amphtml'. This structure provides a placeholder where details from HTML's link element can be represented outside of HTML, e.g. in JSON-LD feeds. */
/** A Role that represents a Web link e.g. as expressed via the 'url' property. Its linkRelationship property can indicate URL-based and plain textual link types e.g. those in IANA link registry or others such as 'amphtml'. This structure provides a placeholder where details from HTML's link element can be represented outside of HTML, e.g. in JSON-LD feeds. */
export declare type LinkRole<TContent = never, TProperty extends string = never> = LinkRoleLeaf<TContent, TProperty>;
export declare type LinkRole<TContent = never, TProperty extends string = never> = LinkRoleLeaf<TContent, TProperty>;
/**
/**
* 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 | `${number}`;
export declare type Number = Float | Integer | number | `${number}`;
interface OrganizationRoleBase extends RoleBase {
interface OrganizationRoleBase extends RoleBase {
/** A number associated with a role in an organization, for example, the number on an athlete's jersey. */
/** A number associated with a role in an organization, for example, the number on an athlete's jersey. */
"numberedPosition"?: SchemaValue<Number, "numberedPosition">;
"numberedPosition"?: SchemaValue<Number, "numberedPosition">;
}
}
declare type OrganizationRoleLeaf<TContent, TProperty extends string> = OrganizationRoleBase & {
declare type OrganizationRoleLeaf<TContent, TProperty extends string> = OrganizationRoleBase & {
"@type": "OrganizationRole";
"@type": "OrganizationRole";
} & {
} & {
[key in TProperty]: TContent;
[key in TProperty]: TContent;
};
};
/** A subclass of Role used to describe roles within organizations. */
/** A subclass of Role used to describe roles within organizations. */
export declare type OrganizationRole<TContent = never, TProperty extends string = never> = OrganizationRoleLeaf<TContent, TProperty> | EmployeeRole<TContent, TProperty>;
export declare type OrganizationRole<TContent = never, TProperty extends string = never> = OrganizationRoleLeaf<TContent, TProperty> | EmployeeRole<TContent, TProperty>;
interface PerformanceRoleBase extends RoleBase {
interface PerformanceRoleBase extends RoleBase {
/** The name of a character played in some acting or performing role, i.e. in a PerformanceRole. */
/** The name of a character played in some acting or performing role, i.e. in a PerformanceRole. */
"characterName"?: SchemaValue<Text, "characterName">;
"characterName"?: SchemaValue<Text, "characterName">;
}
}
declare type PerformanceRoleLeaf<TContent, TProperty extends string> = PerformanceRoleBase & {
declare type PerformanceRoleLeaf<TContent, TProperty extends string> = PerformanceRoleBase & {
"@type": "PerformanceRole";
"@type": "PerformanceRole";
} & {
} & {
[key in TProperty]: TContent;
[key in TProperty]: TContent;
};
};
/** A PerformanceRole is a Role that some entity places with regard to a theatrical performance, e.g. in a Movie, TVSeries etc. */
/** A PerformanceRole is a Role that some entity places with regard to a theatrical performance, e.g. in a Movie, TVSeries etc. */
export declare type PerformanceRole<TContent = never, TProperty extends string = never> = PerformanceRoleLeaf<TContent, TProperty>;
export declare type PerformanceRole<TContent = never, TProperty extends string = never> = PerformanceRoleLeaf<TContent, TProperty>;
interface RoleBase extends ThingBase {
interface RoleBase extends ThingBase {
/** The end date and time of the item (in {@link http://en.wikipedia.org/wiki/ISO_8601 ISO 8601 date format}). */
/** The end date and time of the item (in {@link http://en.wikipedia.org/wiki/ISO_8601 ISO 8601 date format}). */
"endDate"?: SchemaValue<Date | DateTime, "endDate">;
"endDate"?: SchemaValue<Date | DateTime, "endDate">;
/**
/**
* A position played, performed or filled by a person or organization, as part of an organization. For example, an athlete in a SportsTeam might play in the position named 'Quarterback'.
* A position played, performed or filled by a person or organization, as part of an organization. For example, an athlete in a SportsTeam might play in the position named 'Quarterback'.
*
*
* @deprecated Consider using https://schema.org/roleName instead.
* @deprecated Consider using https://schema.org/roleName instead.
*/
*/
"namedPosition"?: SchemaValue<Text | URL, "namedPosition">;
"namedPosition"?: SchemaValue<Text | URL, "namedPosition">;
/** A role played, performed or filled by a person or organization. For example, the team of creators for a comic book might fill the roles named 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might play in the position named 'Quarterback'. */
/** A role played, performed or filled by a person or organization. For example, the team of creators for a comic book might fill the roles named 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might play in the position named 'Quarterback'. */
"roleName"?: SchemaValue<Text | URL, "roleName">;
"roleName"?: SchemaValue<Text | URL, "roleName">;
/** The start date and time of the item (in {@link http://en.wikipedia.org/wiki/ISO_8601 ISO 8601 date format}). */
/** The start date and time of the item (in {@link http://en.wikipedia.org/wiki/ISO_8601 ISO 8601 date format}). */
"startDate"?: SchemaValue<Date | DateTime, "startDate">;
"startDate"?: SchemaValue<Date | DateTime, "startDate">;
}
}
declare type RoleLeaf<TContent, TProperty extends string> = RoleBase & {
declare type RoleLeaf<TContent, TProperty extends string> = RoleBase & {
"@type": "Role";
"@type": "Role";
} & {
} & {
[key in TProperty]: TContent;
[key in TProperty]: TContent;
};
};
/**
/**
* Represents additional information about a relationship or property. For example a Role can be used to say that a 'member' role linking some SportsTeam to a player occurred during a particular time period. Or that a Person's 'actor' role in a Movie was for some particular characterName. Such properties can be attached to a Role entity, which is then associated with the main entities using ordinary properties like 'member' or 'actor'.
* Represents additional information about a relationship or property. For example a Role can be used to say that a 'member' role linking some SportsTeam to a player occurred during a particular time period. Or that a Person's 'actor' role in a Movie was for some particular characterName. Such properties can be attached to a Role entity, which is then associated with the main entities using ordinary properties like 'member' or 'actor'.
*
*
* See also {@link http://blog.schema.org/2014/06/introducing-role.html blog post}.
* See also {@link http://blog.schema.org/2014/06/introducing-role.html blog post}.
*/
*/
export declare type Role<TContent = never, TProperty extends string = never> = RoleLeaf<TContent, TProperty> | LinkRole<TContent, TProperty> | OrganizationRole<TContent, TProperty> | PerformanceRole<TContent, TProperty>;
export declare type Role<TContent = never, TProperty extends string = never> = RoleLeaf<TContent, TProperty> | LinkRole<TContent, TProperty> | OrganizationRole<TContent, TProperty> | PerformanceRole<TContent, TProperty>;
/** 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;
interface _3DModelBase extends MediaObjectBase {
interface _3DModelBase extends 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">;
"isResizable"?: SchemaValue<Boolean, "isResizable">;
}
}
interface _3DModelLeaf extends _3DModelBase {
interface _3DModelLeaf extends _3DModelBase {
"@type": "3DModel";
"@type": "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 the case 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 the case 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;
interface AboutPageLeaf extends WebPageBase {
interface AboutPageLeaf extends WebPageBase {
"@type": "AboutPage";
"@type": "AboutPage";
}
}
/** Web page type: About page. */
/** Web page type: About page. */
export declare type AboutPage = AboutPageLeaf;
export declare type AboutPage = AboutPageLeaf;
interface AcceptActionLeaf extends ActionBase {
interface AcceptActionLeaf extends ActionBase {
"@type": "AcceptAction";
"@type": "AcceptAction";
}
}
/**
/**
* 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;
interface AccommodationBase extends PlaceBase {
interface AccommodationBase extends 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">;
"accommodationCategory"?: SchemaValue<Text, "accommodationCategory">;
/** 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">;
"accommodationFloorPlan"?: SchemaValue<FloorPlan | IdReference, "accommodationFloorPlan">;
/** 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">;
"amenityFeature"?: SchemaValue<LocationFeatureSpecification | IdReference, "amenityFeature">;
/** 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">;
"floorLevel"?: SchemaValue<Text, "floorLevel">;
/** 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">;
"floorSize"?: SchemaValue<QuantitativeValue | IdReference, "floorSize">;
/** 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">;
"leaseLength"?: SchemaValue<Duration | QuantitativeValue | IdReference, "leaseLength">;
/** 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">;
"numberOfBathroomsTotal"?: SchemaValue<Integer, "numberOfBathroomsTotal">;
/** 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">;
"numberOfBedrooms"?: SchemaValue<Number | QuantitativeValue | IdReference, "numberOfBedrooms">;
/** 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 ¾ 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">;
"numberOfFullBathrooms"?: SchemaValue<Number, "numberOfFullBathrooms">;
/** 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 ¼ 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">;
"numberOfPartialBathrooms"?: SchemaValue<Number, "numberOfPartialBathrooms">;
/** 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">;
"numberOfRooms"?: SchemaValue<Number | QuantitativeValue | IdReference, "numberOfRooms">;
/** Indications regarding the permitted usage of the accommodation. */
/** Indications regarding the permitted usage of the accommodation. */
"permittedUsage"?: SchemaValue<Text, "permittedUsage">;
"permittedUsage"?: SchemaValue<Text, "permittedUsage">;
/** 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">;
"petsAllowed"?: SchemaValue<Boolean | Text, "petsAllowed">;
/** 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">;
"tourBookingPage"?: SchemaValue<URL, "tourBookingPage">;
/** 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">;
"yearBuilt"?: SchemaValue<Number, "yearBuilt">;
}
}
interface AccommodationLeaf extends AccommodationBase {
interface AccommodationLeaf extends AccommodationBase {
"@type": "Accommodation";
"@type": "Accommodation";
}
}
/**
/**
* 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;
interface AccountingServiceLeaf extends FinancialServiceBase {
interface AccountingServiceLeaf extends FinancialServiceBase {
"@type": "AccountingService";
"@type": "AccountingService";
}
}
/**
/**
* 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;
interface AchieveActionLeaf extends ActionBase {
interface AchieveActionLeaf extends ActionBase {
"@type": "AchieveAction";
"@type": "AchieveAction";
}
}
/** 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;
interface ActionBase extends ThingBase {
interface ActionBase extends ThingBase {
/** Indicates the current disposition of the Action. */
/** Indicates the current disposition of the Action. */
"actionStatus"?: SchemaValue<ActionStatusType | IdReference, "actionStatus">;
"actionStatus"?: SchemaValue<ActionStatusType | IdReference, "actionStatus">;
/** 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">;
"agent"?: SchemaValue<Organization | Person | IdReference, "agent">;
/**
/**
* 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">;
"endTime"?: SchemaValue<DateTime | Time, "endTime">;
/** 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">;
"error"?: SchemaValue<Thing | IdReference, "error">;
/** 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">;
"instrument"?: SchemaValue<Thing | IdReference, "instrument">;
/** The location of, for example, where an event is happening, where an organization is located, or where an action takes place. */
/** The location of, for example, where an event is happening, where an organization is located, or where an action takes place. */
"location"?: SchemaValue<Place | PostalAddress | Text | VirtualLocation | IdReference, "location">;
"location"?: SchemaValue<Place | PostalAddress | Text | VirtualLocation | IdReference, "location">;
/** 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">;
"object"?: SchemaValue<Thing | IdReference, "object">;
/** 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">;
"participant"?: SchemaValue<Organization | Person | IdReference, "participant">;
/** 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">;
"result"?: SchemaValue<Thing | IdReference, "result">;
/**
/**
* 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">;
"startTime"?: SchemaValue<DateTime | Time, "startTime">;
/** Indicates a target EntryPoint for an Action. */
/** Indicates a target EntryPoint for an Action. */
"target"?: SchemaValue<EntryPoint | IdReference, "target">;
"target"?: SchemaValue<EntryPoint | IdReference, "target">;
}
}
interface ActionLeaf extends ActionBase {
interface ActionLeaf extends ActionBase {
"@type": "Action";
"@type": "Action";
}
}
/**
/**
* 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 | SeekToAction | SolveMathAction | TradeAction | TransferAction | UpdateAction;
export declare type Action = ActionLeaf | AchieveAction | AssessAction | ConsumeAction | ControlAction | CreateAction | FindAction | InteractAction | MoveAction | OrganizeAction | PlayAction | SearchAction | SeekToAction | SolveMathAction | TradeAction | TransferAction | UpdateAction;
interface ActionAccessSpecificationBase extends ThingBase {
interface ActionAccessSpecificationBase extends 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">;
"availabilityEnds"?: SchemaValue<Date | DateTime | Time, "availabilityEnds">;
/** 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">;
"availabilityStarts"?: SchemaValue<Date | DateTime | Time, "availabilityStarts">;
/** 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">;
"category"?: SchemaValue<PhysicalActivityCategory | Text | Thing | URL | IdReference, "category">;
/**
/**
* 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">;
"eligibleRegion"?: SchemaValue<GeoShape | Place | Text | IdReference, "eligibleRegion">;
/** 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">;
"expectsAcceptanceOf"?: SchemaValue<Offer | IdReference, "expectsAcceptanceOf">;
/**
/**
* 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">;
"ineligibleRegion"?: SchemaValue<GeoShape | Place | Text | IdReference, "ineligibleRegion">;
/** 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">;
"requiresSubscription"?: SchemaValue<Boolean | MediaSubscription | IdReference, "requiresSubscription">;
}
}
interface ActionAccessSpecificationLeaf extends ActionAccessSpecificationBase {
interface ActionAccessSpecificationLeaf extends ActionAccessSpecificationBase {
"@type": "ActionAccessSpecification";
"@type": "ActionAccessSpecification";
}
}
/** 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;
interface ActionStatusTypeLeaf extends EnumerationBase {
interface ActionStatusTypeLeaf extends EnumerationBase {
"@type": "ActionStatusType";
"@type": "ActionStatusType";
}
}
/** 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;
interface ActivateActionLeaf extends ActionBase {
interface ActivateActionLeaf extends ActionBase {
"@type": "ActivateAction";
"@type": "ActivateAction";
}
}
/** 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;
interface AddActionLeaf extends UpdateActionBase {
interface AddActionLeaf extends UpdateActionBase {
"@type": "AddAction";
"@type": "AddAction";
}
}
/** 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;
interface AdministrativeAreaLeaf extends PlaceBase {
interface AdministrativeAreaLeaf extends PlaceBase {
"@type": "AdministrativeArea";
"@type": "AdministrativeArea";
}
}
/** 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;
interface AdultEntertainmentLeaf extends LocalBusinessBase {
interface AdultEntertainmentLeaf extends LocalBusinessBase {
"@type": "AdultEntertainment";
"@type": "AdultEntertainment";
}
}
/** An adult entertainment establishment. */
/** An adult entertainment establishment. */
export declare type AdultEntertainment = AdultEntertainmentLeaf | string;
export declare type AdultEntertainment = AdultEntertainmentLeaf | string;
interface AdvertiserContentArticleLeaf extends ArticleBase {
interface AdvertiserContentArticleLeaf extends ArticleBase {
"@type": "AdvertiserContentArticle";
"@type": "AdvertiserContentArticle";
}
}
/** 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;
interface AggregateOfferBase extends OfferBase {
interface AggregateOfferBase extends 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">;
"highPrice"?: SchemaValue<Number | Text, "highPrice">;
/**
/**
* 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">;
"lowPrice"?: SchemaValue<Number | Text, "lowPrice">;
/** The number of offers for the product. */
/** The number of offers for the product. */
"offerCount"?: SchemaValue<Integer, "offerCount">;
"offerCount"?: SchemaValue<Integer, "offerCount">;
/** An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use {@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—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">;
"offers"?: SchemaValue<Demand | Offer | IdReference, "offers">;
}
}
interface AggregateOfferLeaf extends AggregateOfferBase {
interface AggregateOfferLeaf extends AggregateOfferBase {
"@type": "AggregateOffer";
"@type": "AggregateOffer";
}
}
/**
/**
* 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/goodrelati
* 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