reach-api-sdk 1.0.0

package/src/models/Permission.ts

@@ -0,0 +1,77 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents permissions within the Reach application.
+ */
+export type Permission = {
+  /**
+   * 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 a value indicating whether a venue manager has add activities permissions.
+   */
+  venueManagerAddActivities?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has add templates permissions.
+   */
+  venueManagerAddTemplates?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has add venues permissions.
+   */
+  venueManagerAddVenues?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has edit activities permissions.
+   */
+  venueManagerEditActivities?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has edit prices permissions.
+   */
+  venueManagerEditPrices?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has edit schedules permissions.
+   */
+  venueManagerEditSchedules?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has edit sales tax permissions.
+   */
+  venueManagerEditSalesTax?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has edit venues permissions.
+   */
+  venueManagerEditVenue?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has edit orders permissions.
+   */
+  venueManagerEditOrders?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has view advanced settings permissions.
+   */
+  venueManagerViewAdvancedSettings?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has view advanced settings permissions.
+   */
+  venueManagerEditAdvancedSettings?: boolean;
+};

package/src/models/PermissionPage.ts

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

package/src/models/PlaceDetailsResponseModel.ts

@@ -0,0 +1,12 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PlaceResult } from './PlaceResult';
+
+/**
+ * PlaceDetailsResponseModel.
+ */
+export type PlaceDetailsResponseModel = {
+  result?: PlaceResult;
+};

package/src/models/PlaceGeometry.ts

@@ -0,0 +1,14 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PlaceLocation } from './PlaceLocation';
+import type { PlaceViewport } from './PlaceViewport';
+
+/**
+ * PlaceGeometry.
+ */
+export type PlaceGeometry = {
+  location?: PlaceLocation;
+  viewport?: PlaceViewport;
+};

package/src/models/PlaceLocation.ts

@@ -0,0 +1,17 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * PlaceLocation.
+ */
+export type PlaceLocation = {
+  /**
+   * Gets or sets lat.
+   */
+  lat?: number;
+  /**
+   * Gets or sets lng.
+   */
+  lng?: number;
+};

package/src/models/PlaceResult.ts

@@ -0,0 +1,20 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { PlaceGeometry } from './PlaceGeometry';
+
+/**
+ * PlaceResult.
+ */
+export type PlaceResult = {
+  geometry?: PlaceGeometry;
+  /**
+   * Gets or sets formatted_address.
+   */
+  formatted_address?: string | null;
+  /**
+   * Gets or sets place_id.
+   */
+  place_id?: string | null;
+};

package/src/models/PlaceViewport.ts

@@ -0,0 +1,14 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Northeast } from './Northeast';
+import type { Southwest } from './Southwest';
+
+/**
+ * PlaceViewport.
+ */
+export type PlaceViewport = {
+  northeast?: Northeast;
+  southwest?: Southwest;
+};

package/src/models/PlusCode.ts

@@ -0,0 +1,17 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * PlusCode.
+ */
+export type PlusCode = {
+  /**
+   * Gets or sets plus_code.
+   */
+  compound_code?: string | null;
+  /**
+   * Gets description.
+   */
+  readonly description?: string | null;
+};

package/src/models/Prepayment.ts

@@ -0,0 +1,12 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Pre payment options.
+ */
+export enum Prepayment {
+  REQUIRED = 'Required',
+  OPTIONAL = 'Optional',
+  UNAVAILABLE = 'Unavailable',
+}

package/src/models/Programme.ts

@@ -0,0 +1,71 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Course } from './Course';
+import type { Image } from './Image';
+import type { Session } from './Session';
+import type { Tenant } from './Tenant';
+
+/**
+ * Represents a Programme within the Reach application.
+ */
+export type Programme = {
+  /**
+   * 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 programmes name.
+   */
+  name: string;
+  /**
+   * Gets or sets the programmes url slug.
+   */
+  slug?: string | null;
+  /**
+   * Gets or sets the programmes description.
+   */
+  description: string;
+  /**
+   * Gets or sets a value indicating whether the programme is active.
+   */
+  active?: boolean | null;
+  /**
+   * Gets or sets the programmes sort order with 0 as base.
+   */
+  sortOrder?: number | null;
+  tenant?: Tenant;
+  /**
+   * Gets or sets the programmes referenced sessions.
+   */
+  sessions?: Array<Session> | null;
+  /**
+   * Gets or sets the programmes referenced courses.
+   */
+  courses?: Array<Course> | null;
+  /**
+   * Gets or sets the programmes referenced images.
+   */
+  images?: Array<Image> | null;
+};

package/src/models/ProgrammePage.ts

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

package/src/models/ReachEntity.ts

@@ -0,0 +1,18 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The Reach Entity.
+ */
+export enum ReachEntity {
+  TENANT = 'Tenant',
+  VENUE = 'Venue',
+  SLOT = 'Slot',
+  SLOT_SCHEDULE = 'SlotSchedule',
+  FACILITY = 'Facility',
+  FACILITY_INDIVIDUAL = 'FacilityIndividual',
+  SCHEDULED_SESSION = 'ScheduledSession',
+  SESSION = 'Session',
+  COURSE = 'Course',
+}

package/src/models/ReachError.ts

@@ -0,0 +1,17 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { HttpStatusCode } from './HttpStatusCode';
+
+export type ReachError = {
+  readonly correlationId?: string;
+  type?: string | null;
+  readonly title?: string | null;
+  detail?: string | null;
+  clientDetail?: string | null;
+  detailCode?: string | null;
+  status?: HttpStatusCode;
+  errors?: any;
+  readonly clientError?: any;
+};

package/src/models/ReachOperation.ts

@@ -0,0 +1,11 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The Reach Operation performed on an entity.
+ */
+export enum ReachOperation {
+  UPDATED = 'Updated',
+  DELETED = 'Deleted',
+}

package/src/models/RecentOrderActivityReport.ts

@@ -0,0 +1,81 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents the recent order activity report model.
+ */
+export type RecentOrderActivityReport = {
+  /**
+   * 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 venue name.
+   */
+  venue?: string | null;
+  /**
+   * Gets or sets the activity name.
+   */
+  activity?: string | null;
+  /**
+   * Gets or sets the programme name.
+   */
+  programme?: string | null;
+  /**
+   * Gets or sets the remaining inventory value.
+   */
+  remainingInventory?: string | null;
+  /**
+   * Gets or sets the total revenue value.
+   */
+  totalRevenue?: string | null;
+  /**
+   * Gets or sets the total orders value.
+   */
+  totalOrders?: string | null;
+  /**
+   * Gets or sets the revenu last 24 hours value.
+   */
+  revenueLast24Hours?: string | null;
+  /**
+   * Gets or sets the orders last 24 hours value.
+   */
+  ordersLast24Hours?: string | null;
+  /**
+   * Gets or sets the revenue last week value.
+   */
+  revenueLastWeek?: string | null;
+  /**
+   * Gets or sets the orders last week value.
+   */
+  ordersLastWeek?: string | null;
+  /**
+   * Gets or sets the revenue last month value.
+   */
+  revenueLastMonth?: string | null;
+  /**
+   * Gets or sets the orders last month value.
+   */
+  ordersLastMonth?: string | null;
+};

package/src/models/RecentOrderActivityReportPage.ts

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

package/src/models/ScheduleStatus.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * The SlotSchedule active status.
+ */
+export enum ScheduleStatus {
+  PENDING = 'Pending',
+  ACTIVE = 'Active',
+  OFFLINE = 'Offline',
+  EVALUATION_COMPLETE = 'EvaluationComplete',
+}

package/src/models/ScheduledSession.ts

@@ -0,0 +1,139 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { BookingStatus } from './BookingStatus';
+import type { Offer } from './Offer';
+import type { OrderItem } from './OrderItem';
+import type { ScheduledSessionSchedule } from './ScheduledSessionSchedule';
+import type { Session } from './Session';
+import type { SlotAvailabilityStatus } from './SlotAvailabilityStatus';
+import type { SlotStatus } from './SlotStatus';
+import type { WaitlistOpportunity } from './WaitlistOpportunity';
+
+/**
+ * Represents an available lease or booked Slot within the Reach application.
+ */
+export type ScheduledSession = {
+  /**
+   * 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 the slots remaining uses when also considering Order leases. This is computed at runtime since order leases expire silently, that is, there is no process that recalculates remaining uses when an Order lease expiry is reached.
+   */
+  readonly actualRemainingUses?: number | null;
+  /**
+   * Gets a value indicating whether the scheduled session is collidable.
+   */
+  readonly isCollidable?: boolean;
+  /**
+   * Gets a value indicating whether the scheduled session is expired due to passing the end date time.
+   */
+  readonly isExpired?: boolean;
+  /**
+   * Gets a value indicating whether the scheduled session is booked.
+   */
+  readonly isCreatedBySchedule?: boolean;
+  /**
+   * Gets a value indicating whether the scheduled session is deletable.
+   */
+  readonly isDeletable?: boolean;
+  availabilityStatus?: SlotAvailabilityStatus;
+  /**
+   * Gets or sets the session id.
+   */
+  sessionId: string;
+  status?: SlotStatus;
+  /**
+   * Gets or sets the scheduled session creation lease expiry. Preventing other scheduled sessions from overwriting until the lease expires.
+   */
+  leaseExpiry?: string | null;
+  bookingStatus?: BookingStatus;
+  /**
+   * Gets or sets the scheduled session on confirmed conflicted description.
+   */
+  conflictedDescription?: string | null;
+  /**
+   * Gets or sets the scheduled session schedule id.
+   */
+  scheduledSessionScheduleId?: string | null;
+  /**
+   * Gets or sets the scheduled session start date time in UTC as is the applications required convention. (this datetime must always be UTC).
+   */
+  startDateTime: string;
+  /**
+   * Gets or sets the scheduled session end date time in UTC as is the applications required convention. (this datetime must always be UTC).
+   */
+  endDateTime?: string | null;
+  /**
+   * Gets the scheduled sessions period label.
+   */
+  readonly timePeriodLabel?: string | null;
+  /**
+   * Gets the venue time zone (currently is the tenant timezone).
+   */
+  readonly venueTimeZone?: string | null;
+  /**
+   * Gets or sets the scheduled session duration.
+   */
+  durationMinutes: number;
+  /**
+   * Gets or sets the scheduled session remaining uses. Defaults to 1.
+   */
+  remainingUses?: number | null;
+  /**
+   * Gets or sets the scheduled sessions capacity.
+   */
+  capacity?: number | null;
+  /**
+   * Gets or sets a value indicating whether the post activity completion email has been sent.
+   */
+  postCompletionEmailSent?: boolean;
+  /**
+   * Gets a value indicating whether this scheduled session has unlimited capacity.
+   */
+  readonly capacityUnlimited?: boolean | null;
+  session?: Session;
+  scheduledSessionSchedule?: ScheduledSessionSchedule;
+  /**
+   * 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 the related session.
+   */
+  availableOffers?: Array<Offer> | null;
+};

package/src/models/ScheduledSessionPage.ts

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

package/src/models/ScheduledSessionSchedule.ts

@@ -0,0 +1,85 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { ScheduledSession } from './ScheduledSession';
+import type { ScheduleStatus } from './ScheduleStatus';
+import type { Session } from './Session';
+import type { Tenant } from './Tenant';
+
+/**
+ * Represents an organisation within the Reach application.
+ */
+export type ScheduledSessionSchedule = {
+  /**
+   * 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.
+   */
+  sessionId: 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 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;
+  tenant?: Tenant;
+  session?: Session;
+  /**
+   * Gets or sets the slots created for this schedule.
+   */
+  scheduledSessions?: Array<ScheduledSession> | null;
+};