@openactive/models-ts

import * as Joi from 'joi'; import { OaValidationError } from '../oaValidationError'; import * as schema from '../schema'; /** * schema:ShippingRateSettings */ export declare type ShippingRateSettings = { '@type': 'ShippingRateSettings'; '@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; /** * This can be marked 'true' to indicate that some published [[DeliveryTimeSettings]] or [[ShippingRateSettings]] are intended to apply to all [[OfferShippingDetails]] published by the same merchant, when referenced by a [[shippingSettingsLink]] in those settings. It is not meaningful to use a 'true' value for this property alongside a transitTimeLabel (for [[DeliveryTimeSettings]]) or shippingLabel (for [[ShippingRateSettings]]), since this property is for use with unlabelled settings. */ isUnlabelledFallback?: boolean; /** * The shipping rate is the cost of shipping to the specified destination. Typically, the maxValue and currency values (of the [[MonetaryAmount]]) are most appropriate. */ shippingRate?: schema.MonetaryAmountOrSubClass | string; /** * indicates (possibly multiple) shipping destinations. These can be defined in several ways e.g. postalCode ranges. */ shippingDestination?: schema.DefinedRegionOrSubClass | string; /** * Indicates when shipping to a particular [[shippingDestination]] is not available. */ doesNotShip?: boolean; /** * Label to match an [[OfferShippingDetails]] with a [[ShippingRateSettings]] (within the context of a [[shippingSettingsLink]] cross-reference). */ shippingLabel?: string; /** * A monetary value above which (or equal to) the shipping rate becomes free. Intended to be used via an [[OfferShippingDetails]] with [[shippingSettingsLink]] matching this [[ShippingRateSettings]]. */ freeShippingThreshold?: schema.DeliveryChargeSpecificationOrSubClass | schema.MonetaryAmountOrSubClass | 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:ShippingRateSettings * * This differs from ShippingRateSettings 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 ShippingRateSettingsOrSubClass = ShippingRateSettings; /** * schema:ShippingRateSettings - Validation schema (w/ JOI) */ export declare const ShippingRateSettingsJoiSchema: Joi.ObjectSchema; /** * schema:ShippingRateSettings - Validation schema (w/ JOI) * * This differs from ShippingRateSettingsJoiSchema 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 ShippingRateSettingsOrSubClassJoiSchema: Joi.AlternativesSchema; /** * Runtime validator for schema:ShippingRateSettings. * * If some data has a structure which matches a schema:ShippingRateSettings, 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 maybeShippingRateSettings = validateShippingRateSettings(req.body); // `req.body` will have type `any` or `unknown` * if (maybeShippingRateSettings instanceof OaValidationError) { * // From this point on, `maybeShippingRateSettings` will have type `OaValidationError` * const error = maybeShippingRateSettings; * // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you. * } * // From this point on, `maybeShippingRateSettings` will have type `ShippingRateSettings` * const shippingRateSettings = maybeShippingRateSettings; * ``` */ export declare function validateShippingRateSettings(maybeShippingRateSettings: unknown): ShippingRateSettings | OaValidationError;