@openactive/models-ts

import * as Joi from 'joi'; import { OaValidationError } from '../oaValidationError'; import * as schema from '../schema'; /** * schema:Park */ export declare type Park = { '@type': 'Park'; '@context'?: string | string[]; /** * The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details. * */ identifier?: schema.PropertyValueOrSubClass | string; /** * The name of the item. */ name?: string; /** * A description of the item. */ description?: string; /** * A unique url based identifier for the record */ '@id'?: string; /** * The general opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'.\n\n* Days are specified using the following two-letter combinations: ```Mo```, ```Tu```, ```We```, ```Th```, ```Fr```, ```Sa```, ```Su```.\n* Times are specified using 24:00 format. For example, 3pm is specified as ```15:00```, 10am as ```10:00```. \n* Here is an example: <code><time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time></code>.\n* If a business is open 7 days a week, then it can be specified as <code><time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time></code>. */ openingHours?: string; /** * The overall rating, based on a collection of reviews or ratings, of the item. */ aggregateRating?: schema.AggregateRatingOrSubClass | string; /** * Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). */ geoIntersects?: schema.GeospatialGeometryOrSubClass | schema.PlaceOrSubClass | string; /** * Photographs of this place. */ photos?: schema.PhotographOrSubClass | schema.ImageObjectOrSubClass | string; /** * Physical address of the item. */ address?: string | schema.PostalAddressOrSubClass; /** * A page providing information on how to book a tour of some [[Place]], such as an [[Accommodation]] or [[ApartmentComplex]] in a real estate setting, as well as other kinds of tours as appropriate. */ tourBookingPage?: string; /** * The longitude of a location. For example ```-122.08585``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). */ longitude?: string | number; /** * The geo coordinates of the place. */ geo?: schema.GeoCoordinatesOrSubClass | schema.GeoShapeOrSubClass | string; /** * The [Global Location Number](http://www.gs1.org/gln) (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations. */ globalLocationNumber?: string; /** * Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). */ geoCoveredBy?: schema.GeospatialGeometryOrSubClass | schema.PlaceOrSubClass | string; /** * The basic containment relation between a place and one that contains it. */ containedInPlace?: schema.PlaceOrSubClass | string; /** * The special opening hours of a certain place.\n\nUse this to explicitly override general opening hours brought in scope by [[openingHoursSpecification]] or [[openingHours]]. * */ specialOpeningHoursSpecification?: schema.OpeningHoursSpecificationOrSubClass | string; /** * Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). */ geoOverlaps?: schema.PlaceOrSubClass | schema.GeospatialGeometryOrSubClass | string; /** * A photograph of this place. */ photo?: schema.PhotographOrSubClass | schema.ImageObjectOrSubClass | string; /** * The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place. */ isicV4?: string; /** * Review of the item. */ reviews?: schema.ReviewOrSubClass | string; /** * A review of the item. */ review?: schema.ReviewOrSubClass | string; /** * Upcoming or past events associated with this place or organization. */ events?: schema.Event_OrSubClass | string; /** * The opening hours of a certain place. */ openingHoursSpecification?: schema.OpeningHoursSpecificationOrSubClass | string; /** * Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). */ geoWithin?: schema.PlaceOrSubClass | schema.GeospatialGeometryOrSubClass | string; /** * Indicates whether some facility (e.g. [[FoodEstablishment]], [[CovidTestingFacility]]) offers a service that can be used by driving through in a car. In the case of [[CovidTestingFacility]] such facilities could potentially help with social distancing from other potentially-infected users. */ hasDriveThroughService?: boolean; /** * The basic containment relation between a place and one that contains it. */ containedIn?: schema.PlaceOrSubClass | string; /** * Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). */ geoCovers?: schema.GeospatialGeometryOrSubClass | schema.PlaceOrSubClass | string; /** * A URL to a map of the place. */ map?: string; /** * 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?: schema.LocationFeatureSpecificationOrSubClass | string; /** * Upcoming or past event associated with this place, organization, or action. */ event?: schema.Event_OrSubClass | string; /** * A property-value pair representing an additional characteristics of the entitity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.\n\nNote: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism. * */ additionalProperty?: schema.PropertyValueOrSubClass | string; /** * The telephone number. */ telephone?: string; /** * An associated logo. */ logo?: schema.ImageObjectOrSubClass | string; /** * A flag to signal that the item, event, or place is accessible for free. */ isAccessibleForFree?: boolean; /** * The total number of individuals that may attend an event or venue. */ maximumAttendeeCapacity?: number; /** * A slogan or motto associated with the item. */ slogan?: string; /** * A URL to a map of the place. */ maps?: string; /** * A URL to a map of the place. */ hasMap?: string | schema.MapOrSubClass; /** * Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship) */ geoEquals?: schema.PlaceOrSubClass | schema.GeospatialGeometryOrSubClass | string; /** * The basic containment relation between a place and another that it contains. */ containsPlace?: schema.PlaceOrSubClass | string; /** * Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: they have no point in common. They form a set of disconnected geometries." (a symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM)) */ geoDisjoint?: schema.PlaceOrSubClass | schema.GeospatialGeometryOrSubClass | string; /** * The latitude of a location. For example ```37.42242``` ([WGS 84](https://en.wikipedia.org/wiki/World_Geodetic_System)). */ latitude?: string | number; /** * Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room. */ smokingAllowed?: boolean; /** * The fax number. */ faxNumber?: string; /** * A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.\n\nFor example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch. * */ branchCode?: string; /** * Represents spatial relations in which two geometries (or the places they represent) touch: they have at least one boundary point in common, but no interior points." (a symmetric relationship, as defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM) ) */ geoTouches?: schema.PlaceOrSubClass | schema.GeospatialGeometryOrSubClass | string; /** * Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). */ geoCrosses?: schema.GeospatialGeometryOrSubClass | schema.PlaceOrSubClass | string; /** * Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM). */ geoContains?: schema.GeospatialGeometryOrSubClass | schema.PlaceOrSubClass | string; /** * A flag to signal that the [[Place]] is open to public visitors. If this property is omitted there is no assumed default boolean value */ publicAccess?: boolean; /** * URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. */ sameAs?: string; /** * A CreativeWork or Event about this Thing. */ subjectOf?: schema.Event_OrSubClass | schema.CreativeWorkOrSubClass | string; /** * Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. */ potentialAction?: schema.ActionOrSubClass | string; /** * Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details. */ mainEntityOfPage?: schema.CreativeWorkOrSubClass | string; /** * An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. */ additionalType?: string; /** * An alias for the item. */ alternateName?: string; /** * URL of the item. */ url?: string; /** * An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. */ image?: schema.ImageObjectOrSubClass | string; /** * A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. */ disambiguatingDescription?: string; }; /** * schema:Park * * This differs from Park because it also allows for objects that have the type of a model that * sub-classes this model. e.g. `Event_OrSubClass` allows `Event`s as well as `ScheduledSession`s, `SessionSeries`, * etc. */ export declare type ParkOrSubClass = Park; /** * schema:Park - Validation schema (w/ JOI) */ export declare const ParkJoiSchema: Joi.ObjectSchema; /** * schema:Park - Validation schema (w/ JOI) * * This differs from ParkJoiSchema because it also allows for objects that have the type of a model that * sub-classes this model. e.g. `Event.OrSubClassJoiSchema` allows `Event`s as well as `ScheduledSession`s, * `SessionSeries`, etc. */ export declare const ParkOrSubClassJoiSchema: Joi.AlternativesSchema; /** * Runtime validator for schema:Park. * * If some data has a structure which matches a schema:Park, it will be returned with the correct type. * Otherwise, this function returns an OAValidationError with details about why the data does not match. * * Use this to e.g. check a JSON object received in an HTTP request. Example usage (for an express request handler): * * ```ts * const maybePark = validatePark(req.body); // `req.body` will have type `any` or `unknown` * if (maybePark instanceof OaValidationError) { * // From this point on, `maybePark` will have type `OaValidationError` * const error = maybePark; * // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you. * } * // From this point on, `maybePark` will have type `Park` * const park = maybePark; * ``` */ export declare function validatePark(maybePark: unknown): Park | OaValidationError;