@openactive/models-ts

import * as Joi from 'joi'; import { OaValidationError } from '../oaValidationError'; import * as oa from '../oa'; import * as schema from '../schema'; /** * schema:Product */ export declare type Product = { '@type': 'Product'; '@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 product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings. */ hasMeasurement?: schema.QuantitativeValueOrSubClass | string; /** * A predefined value from OfferItemCondition or a textual description of the condition of the product or service, or the products or services included in the offer. */ itemCondition?: schema.OfferItemCondition; /** * The overall rating, based on a collection of reviews or ratings, of the item. */ aggregateRating?: schema.AggregateRatingOrSubClass | string; /** * A standardized size of a product or creative work, specified either through a simple textual string (for example 'XL', '32Wx34L'), a QuantitativeValue with a unitCode, or a comprehensive and structured [[SizeSpecification]]; in other cases, the [[width]], [[height]], [[depth]] and [[weight]] properties may be more applicable. */ size?: schema.DefinedTermOrSubClass | schema.SizeSpecificationOrSubClass | schema.QuantitativeValueOrSubClass | string; /** * The depth of the item. */ depth?: schema.DistanceOrSubClass | schema.QuantitativeValueOrSubClass | string; /** * The height of the item. */ height?: schema.QuantitativeValueOrSubClass | schema.DistanceOrSubClass | string; /** * The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. */ gtin12?: string; /** * A pointer to another, functionally similar product (or multiple products). */ isSimilarTo?: schema.ProductOrSubClass | schema.ServiceOrSubClass | string; /** * The weight of the product or person. */ weight?: schema.QuantitativeValueOrSubClass | string; /** * Indicates a MerchantReturnPolicy that may be applicable. */ hasMerchantReturnPolicy?: schema.MerchantReturnPolicyOrSubClass | string; /** * 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 [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[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?: schema.OfferOrSubClass | schema.DemandOrSubClass | string; /** * The width of the item. */ width?: schema.QuantitativeValueOrSubClass | schema.DistanceOrSubClass | string; /** * A pointer to another product (or multiple products) for which this product is a consumable. */ isConsumableFor?: schema.ProductOrSubClass | string; /** * Review of the item. */ reviews?: schema.ReviewOrSubClass | string; /** * An award won by or for this item. */ award?: string; /** * The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. */ gtin13?: string; /** * A Global Trade Item Number ([GTIN](https://www.gs1.org/standards/id-keys/gtin)). GTINs identify trade items, including products and services, using numeric identification codes. The [[gtin]] property generalizes the earlier [[gtin8]], [[gtin12]], [[gtin13]], and [[gtin14]] properties. The GS1 [digital link specifications](https://www.gs1.org/standards/Digital-Link/) express GTINs as URLs. A correct [[gtin]] value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a [valid GS1 check digit](https://www.gs1.org/services/check-digit-calculator) and meet the other rules for valid GTINs. See also [GS1's GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) and [Wikipedia](https://en.wikipedia.org/wiki/Global_Trade_Item_Number) for more details. Left-padding of the gtin values is not required or encouraged. * */ gtin?: string; /** * A review of the item. */ review?: schema.ReviewOrSubClass | string; /** * Defines the energy efficiency Category (also known as "class" or "rating") for a product according to an international energy efficiency standard. */ hasEnergyConsumptionDetails?: schema.EnergyConsumptionDetailsOrSubClass | string; /** * The color of the product. */ color?: 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; /** * An associated logo. */ logo?: schema.ImageObjectOrSubClass | string; /** * The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. */ mpn?: string; /** * Indicates the [[productGroupID]] for a [[ProductGroup]] that this product [[isVariantOf]]. */ inProductGroupWithID?: string; /** * A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. */ category?: schema.PhysicalActivityCategory | string | schema.ThingOrSubClass; /** * Indicates the kind of product that this is a variant of. In the case of [[ProductModel]], this is a pointer (from a ProductModel) to a base product from which this product is a variant. It is safe to infer that the variant inherits all product features from the base model, unless defined locally. This is not transitive. In the case of a [[ProductGroup]], the group description also serves as a template, representing a set of Products that vary on explicitly defined, specific dimensions only (so it defines both a set of variants, as well as which values distinguish amongst those variants). When used with [[ProductGroup]], this property can apply to any [[Product]] included in the group. */ isVariantOf?: schema.ProductGroupOrSubClass | schema.ProductModelOrSubClass | string; /** * A slogan or motto associated with the item. */ slogan?: string; /** * A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported. */ pattern?: string | schema.DefinedTermOrSubClass; /** * The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. */ sku?: string; /** * Indicates the [NATO stock number](https://en.wikipedia.org/wiki/NATO_Stock_Number) (nsn) of a [[Product]]. */ nsn?: string; /** * The date the item e.g. vehicle was purchased by the current owner. */ purchaseDate?: string; /** * The GTIN-14 code of the product, or the product to which the offer refers. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. */ gtin14?: string; /** * A pointer to another product (or multiple products) for which this product is an accessory or spare part. */ isAccessoryOrSparePartFor?: schema.ProductOrSubClass | string; /** * The manufacturer of the product. */ manufacturer?: schema.OrganizationOrSubClass | string; /** * The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties. */ model?: schema.ProductModelOrSubClass | 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; /** * The release date of a product or product model. This can be used to distinguish the exact variant of a product. */ releaseDate?: string; /** * The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See [GS1 GTIN Summary](http://www.gs1.org/barcodes/technical/idkeys/gtin) for more details. */ gtin8?: string; /** * A material that something is made from, e.g. leather, wool, cotton, paper. */ material?: schema.ProductOrSubClass | string; /** * The date of production of the item, e.g. vehicle. */ productionDate?: string; /** * Awards won by or for this item. */ awards?: string; /** * An intended audience, i.e. a group for whom something was created. */ audience?: schema.AudienceOrSubClass | string; /** * A pointer to another, somehow related product (or multiple products). */ isRelatedTo?: schema.ProductOrSubClass | schema.ServiceOrSubClass | string; /** * The product identifier, such as ISBN. For example: ``` meta itemprop="productID" content="isbn:123-456-789" ```. */ productID?: 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:Product * * This differs from Product 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 ProductOrSubClass = Product | oa.FacilityUseOrSubClass | schema.IndividualProductOrSubClass | schema.SomeProductsOrSubClass | schema.VehicleOrSubClass | schema.ProductCollectionOrSubClass | schema.ProductModelOrSubClass | schema.ProductGroupOrSubClass; /** * schema:Product - Validation schema (w/ JOI) */ export declare const ProductJoiSchema: Joi.ObjectSchema; /** * schema:Product - Validation schema (w/ JOI) * * This differs from ProductJoiSchema 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 ProductOrSubClassJoiSchema: Joi.AlternativesSchema; /** * Runtime validator for schema:Product. * * If some data has a structure which matches a schema:Product, 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 maybeProduct = validateProduct(req.body); // `req.body` will have type `any` or `unknown` * if (maybeProduct instanceof OaValidationError) { * // From this point on, `maybeProduct` will have type `OaValidationError` * const error = maybeProduct; * // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you. * } * // From this point on, `maybeProduct` will have type `Product` * const product = maybeProduct; * ``` */ export declare function validateProduct(maybeProduct: unknown): Product | OaValidationError;