@openactive/models-ts

// This file was generated import * as Joi from 'joi'; import { OaValidationError } from '../oaValidationError'; import * as oa from '../oa'; import * as schema from '../schema'; /** * schema:FloorPlan */ export type FloorPlan = { '@type': 'FloorPlan'; '@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 total integer number of bedrooms in a some [[Accommodation]], [[ApartmentComplex]] or [[FloorPlan]]. */ numberOfBedrooms?: schema.QuantitativeValueOrSubClass | number | string; /** * Number of partial bathrooms - The total number of half and ¼ bathrooms in an [[Accommodation]]. This corresponds to the [BathroomsPartial field in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsPartial+Field). */ numberOfPartialBathrooms?: number; /** * Indicates the number of available accommodation units in an [[ApartmentComplex]], or the number of accommodation units for a specific [[FloorPlan]] (within its specific [[ApartmentComplex]]). See also [[numberOfAccommodationUnits]]. */ numberOfAvailableAccommodationUnits?: schema.QuantitativeValueOrSubClass | string; /** * Indicates some accommodation that this floor plan describes. */ isPlanForApartment?: schema.AccommodationOrSubClass | string; /** * A schematic image showing the floorplan layout. */ layoutImage?: schema.ImageObjectOrSubClass | string; /** * 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?: schema.QuantitativeValueOrSubClass | string; /** * The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business. * Typical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue. */ numberOfRooms?: number | schema.QuantitativeValueOrSubClass | 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; /** * The total integer number of bathrooms in a some [[Accommodation]], following real estate conventions as [documented in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsTotalInteger+Field): "The simple sum of the number of bathrooms. For example for a property with two Full Bathrooms and one Half Bathroom, the Bathrooms Total Integer will be 3.". See also [[numberOfRooms]]. */ numberOfBathroomsTotal?: number; /** * Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value. */ petsAllowed?: string | boolean; /** * Indicates the total (available plus unavailable) number of accommodation units in an [[ApartmentComplex]], or the number of accommodation units for a specific [[FloorPlan]] (within its specific [[ApartmentComplex]]). See also [[numberOfAvailableAccommodationUnits]]. */ numberOfAccommodationUnits?: schema.QuantitativeValueOrSubClass | string; /** * Number of full bathrooms - The total number of full and ¾ bathrooms in an [[Accommodation]]. This corresponds to the [BathroomsFull field in RESO](https://ddwiki.reso.org/display/DDW17/BathroomsFull+Field). */ numberOfFullBathrooms?: number; /** * 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:FloorPlan * * This differs from FloorPlan 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 type FloorPlanOrSubClass = | FloorPlan ; /** * schema:FloorPlan - Validation schema (w/ JOI) */ export const FloorPlanJoiSchema = Joi.object({ '@type': Joi.string().valid('FloorPlan').required(), '@context': Joi.alternatives().try([Joi.string(), Joi.array().items(Joi.string())]), identifier: Joi.alternatives().try(Joi.lazy(() => schema.PropertyValueOrSubClassJoiSchema), Joi.string().uri(), Joi.string()), name: Joi.string(), description: Joi.string(), '@id': Joi.string().uri(), numberOfBedrooms: Joi.alternatives().try(Joi.lazy(() => schema.QuantitativeValueOrSubClassJoiSchema), Joi.number(), Joi.string().uri()), numberOfPartialBathrooms: Joi.number(), numberOfAvailableAccommodationUnits: Joi.alternatives().try(Joi.lazy(() => schema.QuantitativeValueOrSubClassJoiSchema), Joi.string().uri()), isPlanForApartment: Joi.alternatives().try(Joi.lazy(() => schema.AccommodationOrSubClassJoiSchema), Joi.string().uri()), layoutImage: Joi.alternatives().try(Joi.lazy(() => schema.ImageObjectOrSubClassJoiSchema), Joi.string().uri()), floorSize: Joi.alternatives().try(Joi.lazy(() => schema.QuantitativeValueOrSubClassJoiSchema), Joi.string().uri()), numberOfRooms: Joi.alternatives().try(Joi.number(), Joi.lazy(() => schema.QuantitativeValueOrSubClassJoiSchema), Joi.string().uri()), amenityFeature: Joi.alternatives().try(Joi.lazy(() => schema.LocationFeatureSpecificationOrSubClassJoiSchema), Joi.string().uri()), numberOfBathroomsTotal: Joi.number().integer(), petsAllowed: Joi.alternatives().try(Joi.string(), Joi.boolean()), numberOfAccommodationUnits: Joi.alternatives().try(Joi.lazy(() => schema.QuantitativeValueOrSubClassJoiSchema), Joi.string().uri()), numberOfFullBathrooms: Joi.number(), sameAs: Joi.string().uri(), subjectOf: Joi.alternatives().try(Joi.lazy(() => schema.Event_OrSubClassJoiSchema), Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema), Joi.string().uri()), potentialAction: Joi.alternatives().try(Joi.lazy(() => schema.ActionOrSubClassJoiSchema), Joi.string().uri()), mainEntityOfPage: Joi.alternatives().try(Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema), Joi.string().uri()), additionalType: Joi.string().uri(), alternateName: Joi.string(), url: Joi.string().uri(), image: Joi.alternatives().try(Joi.lazy(() => schema.ImageObjectOrSubClassJoiSchema), Joi.string().uri()), disambiguatingDescription: Joi.string(), }); /** * schema:FloorPlan - Validation schema (w/ JOI) * * This differs from FloorPlanJoiSchema 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 const FloorPlanOrSubClassJoiSchema = Joi.alternatives().try([ FloorPlanJoiSchema, ]); /** * Runtime validator for schema:FloorPlan. * * If some data has a structure which matches a schema:FloorPlan, 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 maybeFloorPlan = validateFloorPlan(req.body); // `req.body` will have type `any` or `unknown` * if (maybeFloorPlan instanceof OaValidationError) { * // From this point on, `maybeFloorPlan` will have type `OaValidationError` * const error = maybeFloorPlan; * // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you. * } * // From this point on, `maybeFloorPlan` will have type `FloorPlan` * const floorPlan = maybeFloorPlan; * ``` */ export function validateFloorPlan(maybeFloorPlan: unknown): FloorPlan | OaValidationError { const { value, error } = FloorPlanJoiSchema.validate(maybeFloorPlan); if (error) { return new OaValidationError('FloorPlan', maybeFloorPlan, error); } /* Joi does not implement TS Type Guards, so TS does not implicitly know that this has now been validated to have the right type. Therefore, we just cast it to the right type. */ return value as FloorPlan; }