@openactive/models-ts/src/oa/UnnecessaryPaymentDetailsError.ts

JavaScript/TypeScript implementation of OpenActive's data model

// This file was generated
import * as Joi from 'joi';
import { OaValidationError } from '../oaValidationError';
import * as oa from '../oa';
import * as schema from '../schema';

/**
 * UnnecessaryPaymentDetailsError
 *
 * 
 *
 * Error Use Case: The `payment` property of the `Order` is provided when it is expected to be absent.
 *
 * 
 *
 * This type is derived from https://schema.org/Thing, which means that any of this type's properties within schema.org may also be used.
 */
export type UnnecessaryPaymentDetailsError = {
  '@type': 'UnnecessaryPaymentDetailsError';
  '@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;
  /**
   * A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
   *
   * ```json
   * "name": "The 'payment' property of the 'Order' is provided when it is expected to be absent."
   * ```
   */
  name?: string;
  /**
   * A plain-text human-readable explanation specific to this occurrence of the problem, providing specific information about why the error occurred in this particular case. This description must not include HTML or other markup.
   *
   * ```json
   * "description": "No customer details supplied. These must be supplied for calls to C2, P, and B."
   * ```
   */
  description?: string;
  /**
   * A unique url based identifier for the record
   */
  '@id'?: string;
  /**
   * A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
   */
  instance?: string;
  /**
   * Used by technical support for diagnostics purposes.
   */
  requestId?: string;
  /**
   * Must always be present and set to ```json
   * "statusCode": 400
   * ```
   */
  statusCode?: 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;
};

/**
 * UnnecessaryPaymentDetailsError
 *
 * 
 *
 * Error Use Case: The `payment` property of the `Order` is provided when it is expected to be absent.
 *
 * 
 *
 * This type is derived from https://schema.org/Thing, which means that any of this type's properties within schema.org may also be used.
 *
 * This differs from UnnecessaryPaymentDetailsError 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 UnnecessaryPaymentDetailsErrorOrSubClass =
  | UnnecessaryPaymentDetailsError
  ;

/**
 * UnnecessaryPaymentDetailsError - Validation schema (w/ JOI)
 *
 * 
 *
 * Error Use Case: The `payment` property of the `Order` is provided when it is expected to be absent.
 *
 * 
 *
 * This type is derived from https://schema.org/Thing, which means that any of this type's properties within schema.org may also be used.
 */
export const UnnecessaryPaymentDetailsErrorJoiSchema = Joi.object({
  '@type': Joi.string().valid('UnnecessaryPaymentDetailsError').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(),
  instance: Joi.string().uri(),
  requestId: Joi.string(),
  statusCode: Joi.number().integer(),
  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(),
});

/**
 * UnnecessaryPaymentDetailsError - Validation schema (w/ JOI)
 *
 * 
 *
 * Error Use Case: The `payment` property of the `Order` is provided when it is expected to be absent.
 *
 * 
 *
 * This type is derived from https://schema.org/Thing, which means that any of this type's properties within schema.org may also be used.
 *
 * This differs from UnnecessaryPaymentDetailsErrorJoiSchema 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 UnnecessaryPaymentDetailsErrorOrSubClassJoiSchema = Joi.alternatives().try([
  UnnecessaryPaymentDetailsErrorJoiSchema,
]);

/**
 * Runtime validator for UnnecessaryPaymentDetailsError.
 *
 * If some data has a structure which matches a UnnecessaryPaymentDetailsError, 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 maybeUnnecessaryPaymentDetailsError = validateUnnecessaryPaymentDetailsError(req.body); // `req.body` will have type `any` or `unknown`
 * if (maybeUnnecessaryPaymentDetailsError instanceof OaValidationError) {
 *   // From this point on, `maybeUnnecessaryPaymentDetailsError` will have type `OaValidationError`
 *   const error = maybeUnnecessaryPaymentDetailsError;
 *   // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you.
 * }
 * // From this point on, `maybeUnnecessaryPaymentDetailsError` will have type `UnnecessaryPaymentDetailsError`
 * const unnecessaryPaymentDetailsError = maybeUnnecessaryPaymentDetailsError;
 * ```
 */
export function validateUnnecessaryPaymentDetailsError(maybeUnnecessaryPaymentDetailsError: unknown): UnnecessaryPaymentDetailsError | OaValidationError {
  const { value, error } = UnnecessaryPaymentDetailsErrorJoiSchema.validate(maybeUnnecessaryPaymentDetailsError);
  if (error) {
    return new OaValidationError('UnnecessaryPaymentDetailsError', maybeUnnecessaryPaymentDetailsError, 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 UnnecessaryPaymentDetailsError;
}