@openactive/models-ts/src/oa/Order.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';

/**
 * Order
 *
 * This type is derived from https://schema.org/Order, which means that any of this type's properties within schema.org may also be used.
 */
export type Order = {
  '@type': 'Order';
  '@context'?: string | string[];
  /**
   * The Order UUID of the Order, OrderQuote or OrderProposal, which is required within the Orders feed.
   *
   * ```json
   * "identifier": "123e4567-e89b-12d3-a456-426614174000"
   * ```
   */
  identifier?: string;
  /**
   * The name of the item.
   */
  name?: string;
  /**
   * A description of the item.
   */
  description?: string;
  /**
   * A unique url based identifier for the record
   *
   * ```json
   * "@id": "https://example.com/Order/a4bf0373270be80312345"
   * ```
   */
  '@id'?: string;
  /**
   * Details about the Booking System
   */
  bookingService?: oa.BookingServiceOrSubClass;
  /**
   * The organisation or developer providing an application that allows Customers to make bookings. Those applications will be clients of the API defined in this specification. If brokerRole is set to https://openactive.io/NoBroker this is not required.
   */
  broker?: oa.OrganizationOrSubClass;
  /**
   * Either https://openactive.io/AgentBroker,  https://openactive.io/ResellerBroker or  https://openactive.io/NoBroker, as agreed in advance between the Broker and Seller.
   */
  brokerRole?: oa.BrokerType;
  /**
   * The person or organization purchasing the Order.
   */
  customer?: oa.OrganizationOrSubClass | oa.PersonOrSubClass;
  /**
   * This property is internal to the Broker in this version of the specification.
   */
  orderCreationStatus?: oa.OrderCreationStatus;
  /**
   * The items that constitute the Order.
   */
  orderedItem?: oa.OrderItemOrSubClass[];
  /**
   * The Customer-facing identifier of the Order.
   */
  orderNumber?: string;
  /**
   * The unique URL representing this version of the  OrderProposal, or the version of the OrderProposal to which this Order is related.
   */
  orderProposalVersion?: string;
  /**
   * The payment associated with the Order by the Broker. It is required for cases where a payment has been taken.
   */
  payment?: oa.PaymentOrSubClass;
  /**
   * The organisation (schema:Organization) or person (schema:Person) providing access to events or facilities via a Booking System. e.g. a leisure provider or independent instructor running a yoga classes.
   */
  seller?: oa.PersonOrSubClass | oa.OrganizationOrSubClass | string;
  /**
   * Set to true when business-to-business tax calculation is required by the seller or brokerRole settings, but not supported by the Broker.
   */
  taxCalculationExcluded?: boolean;
  totalPaymentDue?: oa.PriceSpecificationOrSubClass;
  /**
   * Breakdown of tax payable for the Order.
   */
  totalPaymentTax?: oa.TaxChargeSpecificationOrSubClass[];
  /**
   * Was the offer accepted as a gift for someone other than the buyer.
   */
  isGift?: boolean;
  /**
   * The delivery of the parcel related to this order or order item.
   */
  orderDelivery?: schema.ParcelDeliveryOrSubClass | string;
  /**
   * The offer(s) -- e.g., product, quantity and price combinations -- included in the order.
   */
  acceptedOffer?: schema.OfferOrSubClass | string;
  /**
   * The currency of the discount.\n\nUse standard formats: [ISO 4217 currency format](http://en.wikipedia.org/wiki/ISO_4217) e.g. "USD"; [Ticker symbol](https://en.wikipedia.org/wiki/List_of_cryptocurrencies) for cryptocurrencies e.g. "BTC"; well known names for [Local Exchange Tradings Systems](https://en.wikipedia.org/wiki/Local_exchange_trading_system) (LETS) and other currency types e.g. "Ithaca HOUR".
   */
  discountCurrency?: string;
  /**
   * The date that payment is due.
   */
  paymentDue?: string;
  /**
   * A number that confirms the given order or payment has been received.
   */
  confirmationNumber?: string;
  /**
   * An identifier for the method of payment used (e.g. the last 4 digits of the credit card).
   */
  paymentMethodId?: string;
  /**
   * The billing address for the order.
   */
  billingAddress?: schema.PostalAddressOrSubClass | string;
  /**
   * The URL for sending a payment.
   */
  paymentUrl?: string;
  /**
   * The order is being paid as part of the referenced Invoice.
   */
  partOfInvoice?: schema.InvoiceOrSubClass | string;
  /**
   * The date that payment is due.
   */
  paymentDueDate?: string;
  /**
   * 'merchant' is an out-dated term for 'seller'.
   */
  merchant?: schema.PersonOrSubClass | schema.OrganizationOrSubClass | string;
  /**
   * Date order was placed.
   */
  orderDate?: string;
  /**
   * The name of the credit card or other method of payment for the order.
   */
  paymentMethod?: schema.PaymentMethod;
  /**
   * Code used to redeem a discount.
   */
  discountCode?: string;
  /**
   * The current status of the order.
   */
  orderStatus?: schema.OrderStatusOrSubClass | string;
  /**
   * Any discount applied (to an Order).
   */
  discount?: number | 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;
};

/**
 * Order
 *
 * This type is derived from https://schema.org/Order, which means that any of this type's properties within schema.org may also be used.
 *
 * This differs from Order 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 OrderOrSubClass =
  | Order
  | oa.OrderQuoteOrSubClass
  ;

/**
 * Order - Validation schema (w/ JOI)
 *
 * This type is derived from https://schema.org/Order, which means that any of this type's properties within schema.org may also be used.
 */
export const OrderJoiSchema = Joi.object({
  '@type': Joi.string().valid('Order').required(),
  '@context': Joi.alternatives().try([Joi.string(), Joi.array().items(Joi.string())]),
  identifier: Joi.string(),
  name: Joi.string(),
  description: Joi.string(),
  '@id': Joi.string().uri(),
  bookingService: Joi.lazy(() => oa.BookingServiceOrSubClassJoiSchema),
  broker: Joi.lazy(() => oa.OrganizationOrSubClassJoiSchema),
  brokerRole: Joi.lazy(() => oa.BrokerTypeJoiSchema),
  customer: Joi.alternatives().try(Joi.lazy(() => oa.OrganizationOrSubClassJoiSchema), Joi.lazy(() => oa.PersonOrSubClassJoiSchema)),
  orderCreationStatus: Joi.lazy(() => oa.OrderCreationStatusJoiSchema),
  orderedItem: Joi.array().items(Joi.lazy(() => oa.OrderItemOrSubClassJoiSchema)),
  orderNumber: Joi.string(),
  orderProposalVersion: Joi.string().uri(),
  payment: Joi.lazy(() => oa.PaymentOrSubClassJoiSchema),
  seller: Joi.alternatives().try(Joi.lazy(() => oa.PersonOrSubClassJoiSchema), Joi.lazy(() => oa.OrganizationOrSubClassJoiSchema), Joi.string().uri()),
  taxCalculationExcluded: Joi.boolean(),
  totalPaymentDue: Joi.lazy(() => oa.PriceSpecificationOrSubClassJoiSchema),
  totalPaymentTax: Joi.array().items(Joi.lazy(() => oa.TaxChargeSpecificationOrSubClassJoiSchema)),
  isGift: Joi.boolean(),
  orderDelivery: Joi.alternatives().try(Joi.lazy(() => schema.ParcelDeliveryOrSubClassJoiSchema), Joi.string().uri()),
  acceptedOffer: Joi.alternatives().try(Joi.lazy(() => schema.OfferOrSubClassJoiSchema), Joi.string().uri()),
  discountCurrency: Joi.string(),
  paymentDue: Joi.string().isoDate(),
  confirmationNumber: Joi.string(),
  paymentMethodId: Joi.string(),
  billingAddress: Joi.alternatives().try(Joi.lazy(() => schema.PostalAddressOrSubClassJoiSchema), Joi.string().uri()),
  paymentUrl: Joi.string().uri(),
  partOfInvoice: Joi.alternatives().try(Joi.lazy(() => schema.InvoiceOrSubClassJoiSchema), Joi.string().uri()),
  paymentDueDate: Joi.string().isoDate(),
  merchant: Joi.alternatives().try(Joi.lazy(() => schema.PersonOrSubClassJoiSchema), Joi.lazy(() => schema.OrganizationOrSubClassJoiSchema), Joi.string().uri()),
  orderDate: Joi.string().isoDate(),
  paymentMethod: Joi.lazy(() => schema.PaymentMethodJoiSchema),
  discountCode: Joi.string(),
  orderStatus: Joi.alternatives().try(Joi.lazy(() => schema.OrderStatusOrSubClassJoiSchema), Joi.string().uri()),
  discount: Joi.alternatives().try(Joi.number(), Joi.string()),
  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(),
});

/**
 * Order - Validation schema (w/ JOI)
 *
 * This type is derived from https://schema.org/Order, which means that any of this type's properties within schema.org may also be used.
 *
 * This differs from OrderJoiSchema 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 OrderOrSubClassJoiSchema = Joi.alternatives().try([
  OrderJoiSchema,
  Joi.lazy(() => oa.OrderQuoteOrSubClassJoiSchema),
]);

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