reach-api-sdk 1.0.0

package/src/models/Venue.ts

@@ -0,0 +1,187 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Amenity } from './Amenity';
+import type { Country } from './Country';
+import type { Course } from './Course';
+import type { Facility } from './Facility';
+import type { Image } from './Image';
+import type { Session } from './Session';
+import type { StripeAccount } from './StripeAccount';
+import type { Tenant } from './Tenant';
+import type { User } from './User';
+import type { VenueOpeningHours } from './VenueOpeningHours';
+
+/**
+ * Represents a Venue within the Reach application.
+ */
+export type Venue = {
+  /**
+   * 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 venue has sessions.
+   */
+  readonly hasFacilities?: boolean | null;
+  /**
+   * Gets a value indicating whether the venue has online facilities.
+   */
+  readonly hasOnlineFacilities?: boolean | null;
+  /**
+   * Gets a value indicating whether the venue has sessions.
+   */
+  readonly hasSessions?: boolean | null;
+  /**
+   * Gets a value indicating whether the venue has online sessions.
+   */
+  readonly hasOnlineSessions?: boolean | null;
+  /**
+   * Gets a value indicating whether the venue has courses.
+   */
+  readonly hasCourses?: boolean | null;
+  /**
+   * Gets a value indicating whether the venue has online courses.
+   */
+  readonly hasOnlineCourses?: boolean | null;
+  /**
+   * Gets or sets the user that the venue is assigned to.
+   */
+  assignedTo?: string | null;
+  /**
+   * Gets or sets the stripe account for the venue.
+   */
+  stripeAccountId?: string | null;
+  /**
+   * Gets or sets the venues name.
+   */
+  name: string;
+  /**
+   * Gets or sets the venues url slug.
+   */
+  slug?: string | null;
+  /**
+   * Gets or sets the venues description.
+   */
+  description: string;
+  /**
+   * Gets or sets the venues street address.
+   */
+  streetAddress?: string | null;
+  /**
+   * Gets or sets the venues locality.
+   */
+  addressLocality?: string | null;
+  /**
+   * Gets or sets the venues region.
+   */
+  addressRegion?: string | null;
+  /**
+   * Gets or sets the venues postcode.
+   */
+  addressPostalcode?: string | null;
+  /**
+   * Gets or sets the venues Country id.
+   */
+  countryId?: number | null;
+  /**
+   * Gets or sets the venues lat.
+   */
+  lat?: number | null;
+  /**
+   * Gets or sets the venues lng.
+   */
+  lng?: number | null;
+  /**
+   * Gets a value indicating whether the model has valid geo co-ordinates.
+   */
+  readonly hasValidGeoCoordinates?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether opening hours are applicable to the location.
+   */
+  hasOpeningHours?: boolean | null;
+  /**
+   * Gets the venues formatted address.
+   */
+  readonly formattedAddress?: string | null;
+  /**
+   * Gets the venues shortened formatted address.
+   */
+  readonly formattedAddressShortened?: string | null;
+  /**
+   * Gets a value indicating whether the model has valid geo co-ordinates.
+   */
+  readonly distanceFromSearchGeoCenter?: number | null;
+  /**
+   * Gets or sets the contact phone.
+   */
+  contactPhone?: string | null;
+  /**
+   * Gets or sets the contact email.
+   */
+  contactEmail?: string | null;
+  /**
+   * Gets or sets the contact website.
+   */
+  contactWebsite?: string | null;
+  /**
+   * Gets or sets a value indicating whether the venue can take bookings.
+   */
+  online?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the venue is published on the booking website.
+   */
+  publishedOnWeb?: boolean | null;
+  tenant?: Tenant;
+  stripeAccount?: StripeAccount;
+  /**
+   * Gets or sets the amenities.
+   */
+  amenities?: Array<Amenity> | null;
+  /**
+   * Gets or sets the venue managers.
+   */
+  managers?: Array<User> | null;
+  /**
+   * Gets or sets the amenities.
+   */
+  openingHours?: Array<VenueOpeningHours> | null;
+  country?: Country;
+  /**
+   * Gets or sets the venues referenced facilities.
+   */
+  facilities?: Array<Facility> | null;
+  /**
+   * Gets or sets the venues referenced sessions.
+   */
+  sessions?: Array<Session> | null;
+  /**
+   * Gets or sets the venues referenced courses.
+   */
+  courses?: Array<Course> | null;
+  /**
+   * Gets or sets the venues referenced images.
+   */
+  images?: Array<Image> | null;
+};

package/src/models/VenueOpeningHours.ts

@@ -0,0 +1,52 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { DayOfWeek } from './DayOfWeek';
+
+/**
+ * Represents a Venues opening hours within the Reach application.
+ */
+export type VenueOpeningHours = {
+  /**
+   * 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 opening hours venue id.
+   */
+  venueId?: string | null;
+  dayOfWeek?: DayOfWeek;
+  /**
+   * Gets or sets the venues open time.
+   */
+  openTime?: string | null;
+  /**
+   * Gets or sets the venues close time.
+   */
+  closeTime?: string | null;
+  /**
+   * Gets or sets a value indicating whether the venue is closed.
+   */
+  closed?: boolean | null;
+};

package/src/models/VenuePage.ts

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

package/src/models/VenuesReport.ts

@@ -0,0 +1,81 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents the venue report model.
+ */
+export type VenuesReport = {
+  /**
+   * 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 tenant name.
+   */
+  tenantName?: string | null;
+  /**
+   * Gets or sets the venue name.
+   */
+  venueName?: string | null;
+  /**
+   * Gets or sets the published on web value.
+   */
+  publishedOnWeb?: string | null;
+  /**
+   * Gets or sets the stripe connected value.
+   */
+  stripeConnected?: string | null;
+  /**
+   * Gets or sets the venue amenities value.
+   */
+  venueAmenities?: string | null;
+  /**
+   * Gets or sets the venue managers value.
+   */
+  venueManagers?: string | null;
+  /**
+   * Gets or sets the street address value.
+   */
+  streetAddress?: string | null;
+  /**
+   * Gets or sets the address locality value.
+   */
+  addressLocality?: string | null;
+  /**
+   * Gets or sets the address region value.
+   */
+  addressRegion?: string | null;
+  /**
+   * Gets or sets the address postal code value.
+   */
+  addressPostalcode?: string | null;
+  /**
+   * Gets or sets the contact phone value.
+   */
+  contactPhone?: string | null;
+  /**
+   * Gets or sets the contact email value.
+   */
+  contactEmail?: string | null;
+};

package/src/models/VenuesReportPage.ts

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

package/src/models/WaitlistActivity.ts

@@ -0,0 +1,58 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Course } from './Course';
+import type { Session } from './Session';
+
+/**
+ * Represents a waitlist activity within the Reach application.
+ */
+export type WaitlistActivity = {
+  /**
+   * 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 id.
+   */
+  sessionId?: string | null;
+  /**
+   * Gets or sets the course id.
+   */
+  courseId?: string | null;
+  /**
+   * Gets or sets the first name.
+   */
+  firstName?: string | null;
+  /**
+   * Gets or sets the last name.
+   */
+  lastName?: string | null;
+  /**
+   * Gets or sets the email.
+   */
+  email?: string | null;
+  session?: Session;
+  course?: Course;
+};

package/src/models/WaitlistActivityPage.ts

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

package/src/models/WaitlistOpportunity.ts

@@ -0,0 +1,68 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Course } from './Course';
+import type { ScheduledSession } from './ScheduledSession';
+import type { Slot } from './Slot';
+
+/**
+ * Represents a waitlist opportunity within the Reach application.
+ */
+export type WaitlistOpportunity = {
+  /**
+   * 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 id.
+   */
+  slotId?: string | null;
+  /**
+   * Gets or sets the scheduled session id.
+   */
+  scheduledSessionId?: string | null;
+  /**
+   * Gets or sets the course id.
+   */
+  courseId?: string | null;
+  /**
+   * Gets or sets the first name.
+   */
+  firstName?: string | null;
+  /**
+   * Gets or sets the last name.
+   */
+  lastName?: string | null;
+  /**
+   * Gets or sets the email.
+   */
+  email?: string | null;
+  /**
+   * Gets or sets the spaces required.
+   */
+  spacesRequired?: number;
+  slot?: Slot;
+  scheduledSession?: ScheduledSession;
+  course?: Course;
+};

package/src/models/WaitlistOpportunityPage.ts

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

package/src/services/ActivityService.ts

@@ -0,0 +1,118 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Activity } from '../models/Activity';
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class ActivityService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * Gets a Reach.Models.Activity by its Id.
+   * @returns Activity Success
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+  }: {
+    /**
+     * The Reach.Models.Activity id.
+     */
+    id: number;
+  }): CancelablePromise<Activity> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/activities/{id}',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of Reach.Models.Activity.
+   * @returns Activity Success
+   * @throws ApiError
+   */
+  public getList({
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the page number for paged queries.
+     */
+    pageNumber?: number;
+    /**
+     * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
+     */
+    take?: number;
+    /**
+     * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
+     */
+    limitListRequests?: boolean;
+    /**
+     * Gets or sets the Tenant Id.
+     */
+    tenantId?: string;
+    /**
+     * Gets or sets the Modifed By Id.
+     */
+    modifiedById?: string;
+    /**
+     * Gets or sets the Modifed By Ids.
+     */
+    modifiedByIds?: Array<string>;
+    /**
+     * Gets or sets the Date Created greater than equal to.
+     */
+    dateCreatedGte?: string;
+    /**
+     * Gets or sets the Date Created less than equal to.
+     */
+    dateCreatedLte?: string;
+    /**
+     * Gets or sets the queryable only is live status.
+     */
+    isLive?: boolean;
+    /**
+     * Gets or sets the sort order direction.
+     */
+    sortOrderDirection?: SearchSortOrderDirection;
+  }): CancelablePromise<Array<Activity>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/activities',
+      query: {
+        PageNumber: pageNumber,
+        Take: take,
+        LimitListRequests: limitListRequests,
+        TenantId: tenantId,
+        ModifiedById: modifiedById,
+        ModifiedByIds: modifiedByIds,
+        DateCreatedGTE: dateCreatedGte,
+        DateCreatedLTE: dateCreatedLte,
+        IsLive: isLive,
+        SortOrderDirection: sortOrderDirection,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+}