reach-api-sdk 1.0.0

package/src/models/ScheduledSessionSchedulePage.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { ScheduledSessionSchedule } from './ScheduledSessionSchedule';
+
+export type ScheduledSessionSchedulePage = {
+  readonly pageNumber?: number;
+  readonly totalPages?: number;
+  readonly itemsPerPage?: number;
+  readonly totalItems?: number;
+  readonly items?: Array<ScheduledSessionSchedule> | null;
+};

package/src/models/ScheduledSessionSearchSortBy.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The scheduled session search sortby.
+ */
+export enum ScheduledSessionSearchSortBy {
+  START_DATE_TIME = 'StartDateTime',
+}

package/src/models/SearchSortOrderDirection.ts

@@ -0,0 +1,11 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The course search sortby.
+ */
+export enum SearchSortOrderDirection {
+  ASC = 'Asc',
+  DESC = 'Desc',
+}

package/src/models/Session.ts

@@ -0,0 +1,191 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Activity } from './Activity';
+import type { Image } from './Image';
+import type { Offer } from './Offer';
+import type { Programme } from './Programme';
+import type { ScheduledSession } from './ScheduledSession';
+import type { ScheduledSessionSchedule } from './ScheduledSessionSchedule';
+import type { SessionGender } from './SessionGender';
+import type { SessionType } from './SessionType';
+import type { Venue } from './Venue';
+import type { WaitlistActivity } from './WaitlistActivity';
+
+/**
+ * Represents a Reach.Models.Session within a Reach.Models.Session.Venue, for example, tennis courts within a leisure centre.
+ */
+export type Session = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId?: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated?: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified?: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive?: boolean;
+  /**
+   * Gets or sets the session venue id.
+   */
+  venueId?: string | null;
+  /**
+   * Gets or sets the session activity id.
+   */
+  activityId?: number | null;
+  /**
+   * Gets or sets the session programme id.
+   */
+  programmeId?: string | null;
+  /**
+   * Gets or sets the session survey id.
+   */
+  surveyId?: string | null;
+  /**
+   * Gets or sets the course post completion survey id.
+   */
+  postCompletionSurveyId?: string | null;
+  sessionType?: SessionType;
+  /**
+   * Gets or sets the session name.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets the session description.
+   */
+  description?: string | null;
+  /**
+   * Gets or sets the openactive activity Id.
+   */
+  openactiveActivityId?: string | null;
+  /**
+   * Gets or sets the openactive activity pref label.
+   */
+  openactiveActivityPrefLabel?: string | null;
+  /**
+   * Gets or sets the room name.
+   */
+  roomName?: string | null;
+  /**
+   * Gets or sets the meeting instructions.
+   */
+  meetingInstructions?: string | null;
+  /**
+   * Gets or sets the equipment required.
+   */
+  equipmentRequired?: string | null;
+  /**
+   * Gets or sets the capacity.
+   */
+  capacity?: number | null;
+  /**
+   * Gets or sets a value indicating whether the session has unlimited capacity.
+   */
+  capacityUnlimited?: boolean | null;
+  gender?: SessionGender;
+  /**
+   * Gets or sets the min age.
+   */
+  minAge?: number | null;
+  /**
+   * Gets or sets the max age.
+   */
+  maxAge?: number | null;
+  /**
+   * Gets or sets a value indicating whether the session is online and can take bookings.
+   */
+  online?: boolean | null;
+  /**
+   * Gets or sets the additional support.
+   */
+  additionalSupport?: Array<string> | null;
+  /**
+   * Gets or sets the coaching level.
+   */
+  coachingLevel?: string | null;
+  /**
+   * Gets or sets the coach credentials.
+   */
+  coachCredentials?: string | null;
+  /**
+   * Gets or sets the coach bio.
+   */
+  bio?: string | null;
+  /**
+   * Gets or sets the virtual registration url.
+   */
+  virtualRegistrationUrl?: string | null;
+  /**
+   * Gets or sets the virtual registration url.
+   */
+  virtualVideoLink?: string | null;
+  /**
+   * Gets or sets the virtual registration url.
+   */
+  joiningInformation?: string | null;
+  /**
+   * Gets or sets the contact name.
+   */
+  contactName?: string | null;
+  /**
+   * Gets or sets the contact phone.
+   */
+  contactPhone?: string | null;
+  /**
+   * Gets or sets the contact email.
+   */
+  contactEmail?: string | null;
+  /**
+   * Gets or sets the booking link override if checkout will occur externally.
+   */
+  bookingLinkOverride?: string | null;
+  /**
+   * Gets or sets the session that this course was originally copied from.
+   */
+  copiedFrom?: string | null;
+  /**
+   * Gets or sets a value indicating whether the Session can be used as a template.
+   */
+  allowTemplating?: boolean;
+  /**
+   * Gets or sets a value indicating whether the session is archived and should be ignored under normal operation.
+   */
+  archived?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the session is deleted and should be ignored under normal operation.
+   */
+  deleted?: boolean | null;
+  nextAvailableOpportunity?: ScheduledSession;
+  venue?: Venue;
+  activity?: Activity;
+  programme?: Programme;
+  schedule?: ScheduledSessionSchedule;
+  /**
+   * Gets or sets the venues referenced images.
+   */
+  images?: Array<Image> | null;
+  /**
+   * Gets or sets the venues referenced images.
+   */
+  offers?: Array<Offer> | null;
+  /**
+   * Gets or sets the customers on the waitlist.
+   */
+  registrationWaitlist?: Array<WaitlistActivity> | null;
+};

package/src/models/SessionGender.ts

@@ -0,0 +1,12 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The Sesion Gender.
+ */
+export enum SessionGender {
+  MALE = 'Male',
+  FEMALE = 'Female',
+  MIXED = 'Mixed',
+}

package/src/models/SessionPage.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Session } from './Session';
+
+export type SessionPage = {
+  readonly pageNumber?: number;
+  readonly totalPages?: number;
+  readonly itemsPerPage?: number;
+  readonly totalItems?: number;
+  readonly items?: Array<Session> | null;
+};

package/src/models/SessionType.ts

@@ -0,0 +1,12 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The Sesion Type.
+ */
+export enum SessionType {
+  IN_PERSON = 'InPerson',
+  VIRTUAL = 'Virtual',
+  COACHING = 'Coaching',
+}

package/src/models/Slot.ts

@@ -0,0 +1,142 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { BookingStatus } from './BookingStatus';
+import type { Facility } from './Facility';
+import type { FacilityIndividual } from './FacilityIndividual';
+import type { Offer } from './Offer';
+import type { OrderItem } from './OrderItem';
+import type { SlotAvailabilityStatus } from './SlotAvailabilityStatus';
+import type { SlotSchedule } from './SlotSchedule';
+import type { SlotStatus } from './SlotStatus';
+import type { WaitlistOpportunity } from './WaitlistOpportunity';
+
+/**
+ * Represents an available lease or booked Slot within the Reach application.
+ */
+export type Slot = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId?: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated?: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified?: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive?: boolean;
+  /**
+   * Gets a value indicating whether the slot is leased waiting confirmation to be made bookable by the Reach tenant. This status does not refer to a booking lease!.
+   */
+  readonly isLeased?: boolean;
+  /**
+   * Gets a value indicating whether the slot has availability also considering leases.
+   */
+  readonly hasAvailability?: boolean;
+  /**
+   * Gets a value indicating whether the slot is collidable.
+   */
+  readonly isCollidable?: boolean;
+  /**
+   * Gets a value indicating whether the slot is expired due to passing the end date time.
+   */
+  readonly isExpired?: boolean;
+  /**
+   * Gets a value indicating whether the slot is created by a schedule.
+   */
+  readonly isCreatedBySchedule?: boolean;
+  /**
+   * Gets a value indicating whether the slot is deletable.
+   */
+  readonly isDeletable?: boolean;
+  availabilityStatus?: SlotAvailabilityStatus;
+  /**
+   * Gets or sets the facility id.
+   */
+  facilityId: string;
+  /**
+   * Gets or sets the individual facility id.
+   */
+  facilityIndividualId: string;
+  confirmedSlotStatus?: SlotStatus;
+  status?: SlotStatus;
+  /**
+   * Gets or sets a short description for the slot.
+   */
+  shortDescription?: string | null;
+  /**
+   * Gets or sets the slot creation lease expiry. Preventing other slots from overwriting until the lease expires.
+   */
+  leaseExpiry?: string | null;
+  bookingStatus?: BookingStatus;
+  /**
+   * Gets or sets the slot on confirmed conflicted description.
+   */
+  conflictedDescription?: string | null;
+  /**
+   * Gets or sets the slot schedule id.
+   */
+  slotScheduleId?: string | null;
+  /**
+   * Gets or sets the slot start date time in UTC as is the applications required convention. (this datetime must always be UTC).
+   */
+  startDateTime: string;
+  /**
+   * Gets or sets the slot end date time in UTC as is the applications required convention. (this datetime must always be UTC).
+   */
+  endDateTime?: string | null;
+  /**
+   * Gets the slots period label.
+   */
+  readonly timePeriodLabel?: string | null;
+  /**
+   * Gets the venue time zone (currently is the tenant timezone).
+   */
+  readonly venueTimeZone?: string | null;
+  /**
+   * Gets or sets the slot duration.
+   */
+  durationMinutes: number;
+  /**
+   * Gets or sets the slot remaining uses. Defaults to 1.
+   */
+  remainingUses?: number | null;
+  /**
+   * Gets or sets the slots transaction id, used to defect collisions when a slot insert operation contains more than 1 schedule/slot.
+   */
+  transactionId?: string | null;
+  /**
+   * Gets or sets a value indicating whether the post activity completion email has been sent.
+   */
+  postCompletionEmailSent?: boolean;
+  facility?: Facility;
+  facilityIndividual?: FacilityIndividual;
+  slotSchedule?: SlotSchedule;
+  /**
+   * Gets or sets the order items.
+   */
+  orderItems?: Array<OrderItem> | null;
+  /**
+   * Gets or sets the customers on the waitlist for the opportunity.
+   */
+  opportunityWaitlist?: Array<WaitlistOpportunity> | null;
+  /**
+   * Gets or sets the related offers created for this slot.
+   */
+  availableOffers?: Array<Offer> | null;
+};

package/src/models/SlotAvailabilityStatus.ts

@@ -0,0 +1,17 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The SlotAvailabilityStatus status.
+ */
+export enum SlotAvailabilityStatus {
+  AVAILABLE = 'Available',
+  UNAVAILABLE = 'Unavailable',
+  LEASED = 'Leased',
+  BOOKED = 'Booked',
+  ATTENDED = 'Attended',
+  NO_SPACES = 'NoSpaces',
+  OFFLINE = 'Offline',
+  BLOCKED = 'Blocked',
+}

package/src/models/SlotOffer.ts

@@ -0,0 +1,41 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents a relationship between a venue and an amenity.
+ */
+export type SlotOffer = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId?: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated?: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified?: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive?: boolean;
+  /**
+   * Gets or sets the facility venue id.
+   */
+  slotId?: string | null;
+  /**
+   * Gets or sets the facility venue id.
+   */
+  offerId?: string | null;
+};

package/src/models/SlotOfferPage.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { SlotOffer } from './SlotOffer';
+
+export type SlotOfferPage = {
+  readonly pageNumber?: number;
+  readonly totalPages?: number;
+  readonly itemsPerPage?: number;
+  readonly totalItems?: number;
+  readonly items?: Array<SlotOffer> | null;
+};

package/src/models/SlotPage.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Slot } from './Slot';
+
+export type SlotPage = {
+  readonly pageNumber?: number;
+  readonly totalPages?: number;
+  readonly itemsPerPage?: number;
+  readonly totalItems?: number;
+  readonly items?: Array<Slot> | null;
+};

package/src/models/SlotSchedule.ts

@@ -0,0 +1,107 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Facility } from './Facility';
+import type { FacilityIndividual } from './FacilityIndividual';
+import type { Offer } from './Offer';
+import type { ScheduleStatus } from './ScheduleStatus';
+import type { Slot } from './Slot';
+import type { SlotStatus } from './SlotStatus';
+import type { Tenant } from './Tenant';
+
+/**
+ * Represents an organisation within the Reach application.
+ */
+export type SlotSchedule = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId?: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated?: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified?: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive?: boolean;
+  /**
+   * Gets or sets the facilityid.
+   */
+  facilityId: string;
+  /**
+   * Gets or sets the facility individual id.
+   */
+  facilityIndividualId: string;
+  /**
+   * Gets or sets the schedules last run date time.
+   */
+  lastRunDateTime?: string | null;
+  /**
+   * Gets or sets the schedules first occurrence start date time.
+   */
+  startDateTime: string;
+  /**
+   * Gets or sets the schedules first occurrence end date time.
+   */
+  endDateTime?: string | null;
+  /**
+   * Gets or sets the schedules first occurrence duration.
+   */
+  durationMinutes: number;
+  status?: ScheduleStatus;
+  /**
+   * Gets or sets a short description for the slot.
+   */
+  shortDescription?: string | null;
+  /**
+   * Gets or sets the slots hex identifier.
+   */
+  hexIdentifier?: string | null;
+  /**
+   * Gets or sets the schedules evaluated rule string.
+   */
+  rRuleString: string;
+  /**
+   * Gets or sets the schedules end date.
+   */
+  recurUntil?: string | null;
+  /**
+   * Gets or sets a value indicating whether the schedule should recur indefinately.
+   */
+  recurIndefinately?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the schedule is enabled.
+   */
+  enabled?: boolean | null;
+  initialSlotStatus?: SlotStatus;
+  confirmedSlotStatus?: SlotStatus;
+  /**
+   * Gets or sets the slot schedules transaction id, used to defect collisions when a slot insert operation contains more than 1 schedule/slot.
+   */
+  transactionId?: string | null;
+  facility?: Facility;
+  tenant?: Tenant;
+  facilityIndividual?: FacilityIndividual;
+  /**
+   * Gets or sets the slots created for this schedule.
+   */
+  slots?: Array<Slot> | null;
+  /**
+   * Gets or sets the related offers created for this schedule.
+   */
+  availableOffers?: Array<Offer> | null;
+};

package/src/models/SlotScheduleOffer.ts

@@ -0,0 +1,42 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Maps a slot schedule to an offer, slot offers are handled differently to session offers in that the offer cannot
+ * tie directly to the facility - Different facility schedules within the same facility may need different offers applied.
+ */
+export type SlotScheduleOffer = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId?: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated?: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified?: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive?: boolean;
+  /**
+   * Gets or sets the slot schedule id.
+   */
+  slotScheduleId?: string | null;
+  /**
+   * Gets or sets the offer id.
+   */
+  offerId?: string | null;
+};

package/src/models/SlotScheduleOfferPage.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { SlotScheduleOffer } from './SlotScheduleOffer';
+
+export type SlotScheduleOfferPage = {
+  readonly pageNumber?: number;
+  readonly totalPages?: number;
+  readonly itemsPerPage?: number;
+  readonly totalItems?: number;
+  readonly items?: Array<SlotScheduleOffer> | null;
+};

package/src/models/SlotSchedulePage.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { SlotSchedule } from './SlotSchedule';
+
+export type SlotSchedulePage = {
+  readonly pageNumber?: number;
+  readonly totalPages?: number;
+  readonly itemsPerPage?: number;
+  readonly totalItems?: number;
+  readonly items?: Array<SlotSchedule> | null;
+};

package/src/models/SlotStatus.ts

@@ -0,0 +1,18 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The Slot active status.
+ */
+export enum SlotStatus {
+  PENDING = 'Pending',
+  LEASED = 'Leased',
+  LEASED_CAUSING_OVERWRITE = 'LeasedCausingOverwrite',
+  ACTIVE = 'Active',
+  CONFLICT = 'Conflict',
+  OFFLINE = 'Offline',
+  ON_DEMAND = 'OnDemand',
+  GHOSTED = 'Ghosted',
+  BLOCKED = 'Blocked',
+}