UNPKG

@openactive/models-ts

Version:

JavaScript/TypeScript implementation of OpenActive's data model

487 lines (481 loc) 25.2 kB
// This file was generated import * as Joi from 'joi'; import { OaValidationError } from '../oaValidationError'; import * as oa from '../oa'; import * as schema from '../schema'; /** * schema:MusicGroup */ export type MusicGroup = { '@type': 'MusicGroup'; '@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; /** * A member of a music group—for example, John, Paul, George, or Ringo. */ musicGroupMember?: schema.PersonOrSubClass | string; /** * Genre of the creative work, broadcast channel or group. */ genre?: string; /** * A music recording (track)—usually a single song. If an ItemList is given, the list should contain items of type MusicRecording. */ track?: schema.ItemListOrSubClass | schema.MusicRecordingOrSubClass | string; /** * A music album. */ album?: schema.MusicAlbumOrSubClass | string; /** * A music recording (track)—usually a single song. */ tracks?: schema.MusicRecordingOrSubClass | string; /** * A collection of music albums. */ albums?: schema.MusicAlbumOrSubClass | string; /** * The overall rating, based on a collection of reviews or ratings, of the item. */ aggregateRating?: schema.AggregateRatingOrSubClass | string; /** * For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a report on staffing diversity issues. In a news context this might be for example ASNE or RTDNA (US) reports, or self-reported. */ diversityStaffingReport?: schema.ArticleOrSubClass | string; /** * The number of employees in an organization e.g. business. */ numberOfEmployees?: schema.QuantitativeValueOrSubClass | string; /** * People working for this organization. */ employees?: schema.PersonOrSubClass | string; /** * Physical address of the item. */ address?: string | schema.PostalAddressOrSubClass; /** * For an [[Organization]] (e.g. [[NewsMediaOrganization]]), a statement describing (in news media, the newsroom’s) disclosure and correction policy for errors. */ correctionsPolicy?: string | schema.CreativeWorkOrSubClass; /** * For an [[Organization]] (often but not necessarily a [[NewsMediaOrganization]]), a description of organizational ownership structure; funding and grants. In a news/media setting, this is with particular reference to editorial independence. Note that the [[funder]] is also available and can be used to make basic funder information machine-readable. */ ownershipFundingInfo?: string | schema.CreativeWorkOrSubClass | schema.AboutPageOrSubClass; /** * 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; /** * Of a [[Person]], and less typically of an [[Organization]], to indicate a topic that is known about - suggesting possible expertise but not implying it. We do not distinguish skill levels here, or relate this to educational content, events, objectives or [[JobPosting]] descriptions. */ knowsAbout?: string | schema.ThingOrSubClass; /** * A contact point for a person or organization. */ contactPoint?: schema.ContactPointOrSubClass | string; /** * Of a [[Person]], and less typically of an [[Organization]], to indicate a known language. We do not distinguish skill levels or reading/writing/speaking/signing here. Use language codes from the [IETF BCP 47 standard](http://tools.ietf.org/html/bcp47). */ knowsLanguage?: string | schema.LanguageOrSubClass; /** * An organization identifier that uniquely identifies a legal entity as defined in ISO 17442. */ leiCode?: string; /** * A person who founded this organization. */ founder?: schema.PersonOrSubClass | string; /** * A relationship between an organization and a department of that organization, also described as an organization (allowing different urls, logos, opening hours). For example: a store with a pharmacy, or a bakery with a cafe. */ department?: schema.OrganizationOrSubClass | string; /** * Alumni of an organization. */ alumni?: schema.PersonOrSubClass | string; /** * A member of this organization. */ members?: schema.PersonOrSubClass | schema.OrganizationOrSubClass | string; /** * Someone working for this organization. */ employee?: schema.PersonOrSubClass | string; /** * A relationship between two organizations where the first includes the second, e.g., as a subsidiary. See also: the more specific 'department' property. */ subOrganization?: schema.OrganizationOrSubClass | string; /** * The Value-added Tax ID of the organization or person. */ vatID?: string; /** * nonprofit Status indicates the legal status of a non-profit organization in its primary place of business. */ nonprofitStatus?: schema.NonprofitType; /** * The Dun & Bradstreet DUNS number for identifying an organization or business person. */ duns?: string; /** * Indicates a MerchantReturnPolicy that may be applicable. */ hasMerchantReturnPolicy?: schema.MerchantReturnPolicyOrSubClass | string; /** * A contact point for a person or organization. */ contactPoints?: schema.ContactPointOrSubClass | string; /** * For an [[Organization]] (typically a [[NewsMediaOrganization]]), a statement about policy on use of unnamed sources and the decision process required. */ unnamedSourcesPolicy?: schema.CreativeWorkOrSubClass | string; /** * A person who founded this organization. */ founders?: schema.PersonOrSubClass | string; /** * A pointer to products or services offered by the organization or person. */ makesOffer?: schema.OfferOrSubClass | 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; /** * An award won by or for this item. */ award?: 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 geographic area where a service or offered item is provided. */ areaServed?: string | schema.PlaceOrSubClass | schema.AdministrativeAreaOrSubClass | schema.GeoShapeOrSubClass; /** * The date that this organization was dissolved. */ dissolutionDate?: string; /** * A member of an Organization or a ProgramMembership. Organizations can be members of organizations; ProgramMembership is typically for individuals. */ member?: schema.OrganizationOrSubClass | schema.PersonOrSubClass | string; /** * A pointer to products or services sought by the organization or person (demand). */ seeks?: schema.DemandOrSubClass | string; /** * Indicates an OfferCatalog listing for this Organization, Person, or Service. */ hasOfferCatalog?: schema.OfferCatalogOrSubClass | string; /** * Upcoming or past event associated with this place, organization, or action. */ event?: schema.Event_OrSubClass | string; /** * Email address. */ email?: string; /** * The official name of the organization, e.g. the registered company name. */ legalName?: string; /** * A person or organization that supports a thing through a pledge, promise, or financial contribution. e.g. a sponsor of a Medical Study or a corporate sponsor of an event. */ sponsor?: schema.PersonOrSubClass | schema.OrganizationOrSubClass | string; /** * The telephone number. */ telephone?: string; /** * The date that this organization was founded. */ foundingDate?: string; /** * An associated logo. */ logo?: schema.ImageObjectOrSubClass | string; /** * The larger organization that this organization is a [[subOrganization]] of, if any. */ parentOrganization?: schema.OrganizationOrSubClass | string; /** * Statement about ethics policy, e.g. of a [[NewsMediaOrganization]] regarding journalistic and publishing practices, or of a [[Restaurant]], a page describing food source policies. In the case of a [[NewsMediaOrganization]], an ethicsPolicy is typically a statement describing the personal, organizational, and corporate standards of behavior expected by the organization. */ ethicsPolicy?: string | schema.CreativeWorkOrSubClass; /** * A slogan or motto associated with the item. */ slogan?: string; /** * Products owned by the organization or person. */ owns?: schema.OwnershipInfoOrSubClass | schema.ProductOrSubClass | string; /** * The number of interactions for the CreativeWork using the WebSite or SoftwareApplication. The most specific child type of InteractionCounter should be used. */ interactionStatistic?: schema.InteractionCounterOrSubClass | string; /** * The geographic area where the service is provided. */ serviceArea?: schema.PlaceOrSubClass | schema.AdministrativeAreaOrSubClass | schema.GeoShapeOrSubClass | string; /** * For a [[NewsMediaOrganization]] or other news-related [[Organization]], a statement about public engagement activities (for news media, the newsroom’s), including involving the public - digitally or otherwise -- in coverage decisions, reporting and activities after publication. */ actionableFeedbackPolicy?: schema.CreativeWorkOrSubClass | string; /** * The fax number. */ faxNumber?: string; /** * An Organization (or ProgramMembership) to which this Person or Organization belongs. */ memberOf?: schema.ProgramMembershipOrSubClass | schema.OrganizationOrSubClass | string; /** * A credential awarded to the Person or Organization. */ hasCredential?: schema.EducationalOccupationalCredentialOrSubClass | string; /** * The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. */ brand?: schema.BrandOrSubClass | schema.OrganizationOrSubClass | string; /** * Statement on diversity policy by an [[Organization]] e.g. a [[NewsMediaOrganization]]. For a [[NewsMediaOrganization]], a statement describing the newsroom’s diversity policy on both staffing and sources, typically providing staffing data. */ diversityPolicy?: schema.CreativeWorkOrSubClass | string; /** * The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain. */ taxID?: string; /** * The North American Industry Classification System (NAICS) code for a particular organization or business person. */ naics?: string; /** * A person or organization that supports (sponsors) something through some kind of financial contribution. */ funder?: schema.OrganizationOrSubClass | schema.PersonOrSubClass | string; /** * The publishingPrinciples property indicates (typically via [[URL]]) a document describing the editorial principles of an [[Organization]] (or individual e.g. a [[Person]] writing a blog) that relate to their activities as a publisher, e.g. ethics or diversity policies. When applied to a [[CreativeWork]] (e.g. [[NewsArticle]]) the principles are those of the party primarily responsible for the creation of the [[CreativeWork]]. * * While such policies are most typically expressed in natural language, sometimes related information (e.g. indicating a [[funder]]) can be expressed using schema.org terminology. * */ publishingPrinciples?: string | schema.CreativeWorkOrSubClass; /** * Awards won by or for this item. */ awards?: string; /** * The location of, for example, where an event is happening, where an organization is located, or where an action takes place. */ location?: schema.PlaceOrSubClass | string | schema.VirtualLocationOrSubClass | schema.PostalAddressOrSubClass; /** * Points-of-Sales operated by the organization or person. */ hasPOS?: schema.PlaceOrSubClass | string; /** * The place where the Organization was founded. */ foundingLocation?: schema.PlaceOrSubClass | string; /** * 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:MusicGroup * * This differs from MusicGroup 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 MusicGroupOrSubClass = | MusicGroup ; /** * schema:MusicGroup - Validation schema (w/ JOI) */ export const MusicGroupJoiSchema = Joi.object({ '@type': Joi.string().valid('MusicGroup').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(), musicGroupMember: Joi.alternatives().try(Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.string().uri()), genre: Joi.alternatives().try(Joi.string().uri(), Joi.string()), track: Joi.alternatives().try(Joi.lazy(() => schema.ItemListOrSubClassJoiSchema), Joi.lazy(() => schema.MusicRecordingOrSubClassJoiSchema), Joi.string().uri()), album: Joi.alternatives().try(Joi.lazy(() => schema.MusicAlbumOrSubClassJoiSchema), Joi.string().uri()), tracks: Joi.alternatives().try(Joi.lazy(() => schema.MusicRecordingOrSubClassJoiSchema), Joi.string().uri()), albums: Joi.alternatives().try(Joi.lazy(() => schema.MusicAlbumOrSubClassJoiSchema), Joi.string().uri()), aggregateRating: Joi.alternatives().try(Joi.lazy(() => schema.AggregateRatingOrSubClassJoiSchema), Joi.string().uri()), diversityStaffingReport: Joi.alternatives().try(Joi.lazy(() => schema.ArticleOrSubClassJoiSchema), Joi.string().uri()), numberOfEmployees: Joi.alternatives().try(Joi.lazy(() => schema.QuantitativeValueOrSubClassJoiSchema), Joi.string().uri()), employees: Joi.alternatives().try(Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.string().uri()), address: Joi.alternatives().try(Joi.string(), Joi.lazy(() => schema.PostalAddressOrSubClassJoiSchema), Joi.string().uri()), correctionsPolicy: Joi.alternatives().try(Joi.string().uri(), Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema)), ownershipFundingInfo: Joi.alternatives().try(Joi.string(), Joi.string().uri(), Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema), Joi.lazy(() => schema.AboutPageOrSubClassJoiSchema)), globalLocationNumber: Joi.string(), knowsAbout: Joi.alternatives().try(Joi.string(), Joi.string().uri(), Joi.lazy(() => schema.ThingOrSubClassJoiSchema)), contactPoint: Joi.alternatives().try(Joi.lazy(() => schema.ContactPointOrSubClassJoiSchema), Joi.string().uri()), knowsLanguage: Joi.alternatives().try(Joi.string(), Joi.lazy(() => schema.LanguageOrSubClassJoiSchema), Joi.string().uri()), leiCode: Joi.string(), founder: Joi.alternatives().try(Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.string().uri()), department: Joi.alternatives().try(Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.string().uri()), alumni: Joi.alternatives().try(Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.string().uri()), members: Joi.alternatives().try(Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.string().uri()), employee: Joi.alternatives().try(Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.string().uri()), subOrganization: Joi.alternatives().try(Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.string().uri()), vatID: Joi.string(), nonprofitStatus: Joi.lazy(() => schema.NonprofitTypeJoiSchema), duns: Joi.string(), hasMerchantReturnPolicy: Joi.alternatives().try(Joi.lazy(() => schema.MerchantReturnPolicyOrSubClassJoiSchema), Joi.string().uri()), contactPoints: Joi.alternatives().try(Joi.lazy(() => schema.ContactPointOrSubClassJoiSchema), Joi.string().uri()), unnamedSourcesPolicy: Joi.alternatives().try(Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema), Joi.string().uri()), founders: Joi.alternatives().try(Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.string().uri()), makesOffer: Joi.alternatives().try(Joi.lazy(() => schema.OfferOrSubClassJoiSchema), Joi.string().uri()), isicV4: Joi.string(), reviews: Joi.alternatives().try(Joi.lazy(() => schema.ReviewOrSubClassJoiSchema), Joi.string().uri()), award: Joi.string(), review: Joi.alternatives().try(Joi.lazy(() => schema.ReviewOrSubClassJoiSchema), Joi.string().uri()), events: Joi.alternatives().try(Joi.lazy(() => schema.Event_OrSubClassJoiSchema), Joi.string().uri()), areaServed: Joi.alternatives().try(Joi.string(), Joi.lazy(() => schema.PlaceOrSubClassJoiSchema), Joi.lazy(() => schema.AdministrativeAreaOrSubClassJoiSchema), Joi.lazy(() => schema.GeoShapeOrSubClassJoiSchema), Joi.string().uri()), dissolutionDate: Joi.string().isoDate(), member: Joi.alternatives().try(Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.string().uri()), seeks: Joi.alternatives().try(Joi.lazy(() => schema.DemandOrSubClassJoiSchema), Joi.string().uri()), hasOfferCatalog: Joi.alternatives().try(Joi.lazy(() => schema.OfferCatalogOrSubClassJoiSchema), Joi.string().uri()), event: Joi.alternatives().try(Joi.lazy(() => schema.Event_OrSubClassJoiSchema), Joi.string().uri()), email: Joi.string(), legalName: Joi.string(), sponsor: Joi.alternatives().try(Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.string().uri()), telephone: Joi.string(), foundingDate: Joi.string().isoDate(), logo: Joi.alternatives().try(Joi.lazy(() => schema.ImageObjectOrSubClassJoiSchema), Joi.string().uri()), parentOrganization: Joi.alternatives().try(Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.string().uri()), ethicsPolicy: Joi.alternatives().try(Joi.string().uri(), Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema)), slogan: Joi.string(), owns: Joi.alternatives().try(Joi.lazy(() => schema.OwnershipInfoOrSubClassJoiSchema), Joi.lazy(() => schema.ProductOrSubClassJoiSchema), Joi.string().uri()), interactionStatistic: Joi.alternatives().try(Joi.lazy(() => schema.InteractionCounterOrSubClassJoiSchema), Joi.string().uri()), serviceArea: Joi.alternatives().try(Joi.lazy(() => schema.PlaceOrSubClassJoiSchema), Joi.lazy(() => schema.AdministrativeAreaOrSubClassJoiSchema), Joi.lazy(() => schema.GeoShapeOrSubClassJoiSchema), Joi.string().uri()), actionableFeedbackPolicy: Joi.alternatives().try(Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema), Joi.string().uri()), faxNumber: Joi.string(), memberOf: Joi.alternatives().try(Joi.lazy(() => schema.ProgramMembershipOrSubClassJoiSchema), Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.string().uri()), hasCredential: Joi.alternatives().try(Joi.lazy(() => schema.EducationalOccupationalCredentialOrSubClassJoiSchema), Joi.string().uri()), brand: Joi.alternatives().try(Joi.lazy(() => schema.BrandOrSubClassJoiSchema), Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.string().uri()), diversityPolicy: Joi.alternatives().try(Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema), Joi.string().uri()), taxID: Joi.string(), naics: Joi.string(), funder: Joi.alternatives().try(Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.string().uri()), publishingPrinciples: Joi.alternatives().try(Joi.string().uri(), Joi.lazy(() => schema.CreativeWorkOrSubClassJoiSchema)), awards: Joi.string(), location: Joi.alternatives().try(Joi.lazy(() => schema.PlaceOrSubClassJoiSchema), Joi.string(), Joi.lazy(() => schema.VirtualLocationOrSubClassJoiSchema), Joi.lazy(() => schema.PostalAddressOrSubClassJoiSchema), Joi.string().uri()), hasPOS: Joi.alternatives().try(Joi.lazy(() => schema.PlaceOrSubClassJoiSchema), Joi.string().uri()), foundingLocation: Joi.alternatives().try(Joi.lazy(() => schema.PlaceOrSubClassJoiSchema), Joi.string().uri()), 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:MusicGroup - Validation schema (w/ JOI) * * This differs from MusicGroupJoiSchema 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 MusicGroupOrSubClassJoiSchema = Joi.alternatives().try([ MusicGroupJoiSchema, ]); /** * Runtime validator for schema:MusicGroup. * * If some data has a structure which matches a schema:MusicGroup, 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 maybeMusicGroup = validateMusicGroup(req.body); // `req.body` will have type `any` or `unknown` * if (maybeMusicGroup instanceof OaValidationError) { * // From this point on, `maybeMusicGroup` will have type `OaValidationError` * const error = maybeMusicGroup; * // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you. * } * // From this point on, `maybeMusicGroup` will have type `MusicGroup` * const musicGroup = maybeMusicGroup; * ``` */ export function validateMusicGroup(maybeMusicGroup: unknown): MusicGroup | OaValidationError { const { value, error } = MusicGroupJoiSchema.validate(maybeMusicGroup); if (error) { return new OaValidationError('MusicGroup', maybeMusicGroup, 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 MusicGroup; }