reach-api-sdk 1.0.191 → 1.0.193

package/src/index.ts

@@ -386,6 +386,7 @@ export type { TotalRevenueReportPage } from './models/TotalRevenueReportPage';
 export type { TotalRevenueReportPatch } from './models/TotalRevenueReportPatch';
 export type { TotalRevenueReportPost } from './models/TotalRevenueReportPost';
 export type { UnsplashSearchResponse } from './models/UnsplashSearchResponse';
+export { UpcomingLayout } from './models/UpcomingLayout';
 export type { UpdateEmailSettings } from './models/UpdateEmailSettings';
 export type { UpdateOffer } from './models/UpdateOffer';
 export type { User } from './models/User';
@@ -500,6 +501,7 @@ export { ProgrammesService } from './services/ProgrammesService';
 export { ProvidersService } from './services/ProvidersService';
 export { ProviderTypesService } from './services/ProviderTypesService';
 export { PublicBookingService } from './services/PublicBookingService';
+export { PublicCalendarService } from './services/PublicCalendarService';
 export { PublicCoursesService } from './services/PublicCoursesService';
 export { PublicCustomersService } from './services/PublicCustomersService';
 export { PublicFacilitiesService } from './services/PublicFacilitiesService';

package/src/models/Course.ts

@@ -168,6 +168,10 @@ export type Course = {
    * Gets or sets the admin contact email.
    */
   adminContactEmail?: string | null;
+  /**
+   * Gets or sets a valu indicating whether to send the reminder email.
+   */
+  sendReminder?: boolean | null;
   /**
    * Gets or sets the reminder hours before start.
    */
@@ -177,6 +181,10 @@ export type Course = {
    * Gets or sets the booking link override if checkout will occur externally.
    */
   bookingLinkOverride?: string | null;
+  /**
+   * Gets or sets a value indicating whether the activity should be featured on the storefront.
+   */
+  featured?: boolean;
   /**
    * Gets the computed image url.
    */

package/src/models/GenericActivity.ts

@@ -106,6 +106,10 @@ export type GenericActivity = {
    * Gets or sets a value indicating whether there is an age restriction.
    */
   noAgeRestriction?: boolean;
+  /**
+   * Gets or sets a value indicating whether the activity should be featured on the storefront.
+   */
+  featured?: boolean;
   /**
    * Gets or sets the start date.
    */

package/src/models/Session.ts

@@ -161,6 +161,10 @@ export type Session = {
    * Gets or sets the admin contact email.
    */
   adminContactEmail?: string | null;
+  /**
+   * Gets or sets a valu indicating whether to send the reminder email.
+   */
+  sendReminder?: boolean | null;
   /**
    * Gets or sets the reminder hours before start.
    */
@@ -170,6 +174,10 @@ export type Session = {
    * Gets or sets the booking link override if checkout will occur externally.
    */
   bookingLinkOverride?: string | null;
+  /**
+   * Gets or sets a value indicating whether the activity should be featured on the storefront.
+   */
+  featured?: boolean;
   /**
    * Gets the computed image url.
    */

package/src/models/TenantWebsiteSetting.ts

@@ -3,6 +3,8 @@
 /* tslint:disable */
 /* eslint-disable */
 
+import type { UpcomingLayout } from './UpcomingLayout';
+
 /**
  * Represents an organisation within the Reach application.
  */
@@ -95,4 +97,5 @@ export type TenantWebsiteSetting = {
    * Gets or sets the tenants website marketing optin text.
    */
   tenantMarketingOptinText?: string | null;
+  upcomingLayout?: UpcomingLayout;
 };

package/src/models/UpcomingLayout.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * UpcomingLayout.
+ */
+export enum UpcomingLayout {
+  GRID = 'Grid',
+  CALENDAR = 'Calendar',
+}

package/src/services/BookingService.ts

@@ -107,6 +107,7 @@ export class BookingService {
     orderStages,
     orderDateGte,
     orderDateLte,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -192,6 +193,10 @@ export class BookingService {
      * Gets or sets the queryable order date created is less than or equal to.
      */
     orderDateLte?: string;
+    /**
+     * Gets or sets the end user identity Id for use in a query search.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -265,6 +270,7 @@ export class BookingService {
         OrderStages: orderStages,
         OrderDateGTE: orderDateGte,
         OrderDateLTE: orderDateLte,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -312,6 +318,7 @@ export class BookingService {
     orderStages,
     orderDateGte,
     orderDateLte,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -397,6 +404,10 @@ export class BookingService {
      * Gets or sets the queryable order date created is less than or equal to.
      */
     orderDateLte?: string;
+    /**
+     * Gets or sets the end user identity Id for use in a query search.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -470,6 +481,7 @@ export class BookingService {
         OrderStages: orderStages,
         OrderDateGTE: orderDateGte,
         OrderDateLTE: orderDateLte,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -646,6 +658,7 @@ export class BookingService {
     orderStages,
     orderDateGte,
     orderDateLte,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -730,6 +743,10 @@ export class BookingService {
      * Gets or sets the queryable order date created is less than or equal to.
      */
     orderDateLte?: string;
+    /**
+     * Gets or sets the end user identity Id for use in a query search.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -797,6 +814,7 @@ export class BookingService {
         OrderStages: orderStages,
         OrderDateGTE: orderDateGte,
         OrderDateLTE: orderDateLte,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -922,6 +940,7 @@ export class BookingService {
     orderStages,
     orderDateGte,
     orderDateLte,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -1006,6 +1025,10 @@ export class BookingService {
      * Gets or sets the queryable order date created is less than or equal to.
      */
     orderDateLte?: string;
+    /**
+     * Gets or sets the end user identity Id for use in a query search.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -1073,6 +1096,7 @@ export class BookingService {
         OrderStages: orderStages,
         OrderDateGTE: orderDateGte,
         OrderDateLTE: orderDateLte,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -1117,6 +1141,7 @@ export class BookingService {
     orderStages,
     orderDateGte,
     orderDateLte,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -1201,6 +1226,10 @@ export class BookingService {
      * Gets or sets the queryable order date created is less than or equal to.
      */
     orderDateLte?: string;
+    /**
+     * Gets or sets the end user identity Id for use in a query search.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -1268,6 +1297,7 @@ export class BookingService {
         OrderStages: orderStages,
         OrderDateGTE: orderDateGte,
         OrderDateLTE: orderDateLte,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -1312,6 +1342,7 @@ export class BookingService {
     orderStages,
     orderDateGte,
     orderDateLte,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -1396,6 +1427,10 @@ export class BookingService {
      * Gets or sets the queryable order date created is less than or equal to.
      */
     orderDateLte?: string;
+    /**
+     * Gets or sets the end user identity Id for use in a query search.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -1463,6 +1498,7 @@ export class BookingService {
         OrderStages: orderStages,
         OrderDateGTE: orderDateGte,
         OrderDateLTE: orderDateLte,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,

package/src/services/CoursesService.ts

@@ -282,7 +282,7 @@ export class CoursesService {
   }
 
   /**
-   * Asign deal to course />.
+   * Assign deal to course />.
    * @returns Course OK
    * @throws ApiError
    */
@@ -315,7 +315,7 @@ export class CoursesService {
   }
 
   /**
-   * Unasign deal from course />.
+   * Unassign deal from course />.
    * @returns Course OK
    * @throws ApiError
    */
@@ -347,6 +347,60 @@ export class CoursesService {
     });
   }
 
+  /**
+   * Set the course as featured (displays more prominently on the storefront).
+   * @returns Course OK
+   * @throws ApiError
+   */
+  public setFeatured({
+    id,
+  }: {
+    /**
+     * The course Id.
+     */
+    id: string;
+  }): CancelablePromise<Course> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/courses/{id}/set-featured',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Remove the course as featured (displays as standard on the storefront).
+   * @returns Course OK
+   * @throws ApiError
+   */
+  public removeFeatured({
+    id,
+  }: {
+    /**
+     * The course Id.
+     */
+    id: string;
+  }): CancelablePromise<Course> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/courses/{id}/remove-featured',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
   /**
    * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
    * @returns Course OK
@@ -494,6 +548,7 @@ export class CoursesService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     bookingStatus,
     startDateTimeLte,
     startDateTimeGte,
@@ -503,6 +558,7 @@ export class CoursesService {
     remainingUsesGte,
     futureOnly,
     online,
+    featured,
     hasAvailability,
     orderFirstNameContains,
     orderLastNameContains,
@@ -568,6 +624,10 @@ export class CoursesService {
      * Gets or sets a value indicating this an openactive reaquest.
      */
     openActiveUpdate?: boolean;
+    /**
+     * Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
+     */
+    dashboardRequest?: boolean;
     /**
      * Gets or sets the queryable booking status.
      */
@@ -604,6 +664,10 @@ export class CoursesService {
      * Gets or sets a value indicating whether return online courses.
      */
     online?: boolean;
+    /**
+     * Gets or sets a value indicating whether the course is featured on the storefront.
+     */
+    featured?: boolean;
     /**
      * Gets or sets a value indicating whether the scheduled session has availability.
      */
@@ -700,6 +764,7 @@ export class CoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,
@@ -709,6 +774,7 @@ export class CoursesService {
         RemainingUsesGTE: remainingUsesGte,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         HasAvailability: hasAvailability,
         OrderFirstNameContains: orderFirstNameContains,
         OrderLastNameContains: orderLastNameContains,
@@ -836,6 +902,7 @@ export class CoursesService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     bookingStatus,
     startDateTimeLte,
     startDateTimeGte,
@@ -845,6 +912,7 @@ export class CoursesService {
     remainingUsesGte,
     futureOnly,
     online,
+    featured,
     hasAvailability,
     orderFirstNameContains,
     orderLastNameContains,
@@ -910,6 +978,10 @@ export class CoursesService {
      * Gets or sets a value indicating this an openactive reaquest.
      */
     openActiveUpdate?: boolean;
+    /**
+     * Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
+     */
+    dashboardRequest?: boolean;
     /**
      * Gets or sets the queryable booking status.
      */
@@ -946,6 +1018,10 @@ export class CoursesService {
      * Gets or sets a value indicating whether return online courses.
      */
     online?: boolean;
+    /**
+     * Gets or sets a value indicating whether the course is featured on the storefront.
+     */
+    featured?: boolean;
     /**
      * Gets or sets a value indicating whether the scheduled session has availability.
      */
@@ -1042,6 +1118,7 @@ export class CoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,
@@ -1051,6 +1128,7 @@ export class CoursesService {
         RemainingUsesGTE: remainingUsesGte,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         HasAvailability: hasAvailability,
         OrderFirstNameContains: orderFirstNameContains,
         OrderLastNameContains: orderLastNameContains,
@@ -1097,6 +1175,7 @@ export class CoursesService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     bookingStatus,
     startDateTimeLte,
     startDateTimeGte,
@@ -1106,6 +1185,7 @@ export class CoursesService {
     remainingUsesGte,
     futureOnly,
     online,
+    featured,
     hasAvailability,
     orderFirstNameContains,
     orderLastNameContains,
@@ -1171,6 +1251,10 @@ export class CoursesService {
      * Gets or sets a value indicating this an openactive reaquest.
      */
     openActiveUpdate?: boolean;
+    /**
+     * Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
+     */
+    dashboardRequest?: boolean;
     /**
      * Gets or sets the queryable booking status.
      */
@@ -1207,6 +1291,10 @@ export class CoursesService {
      * Gets or sets a value indicating whether return online courses.
      */
     online?: boolean;
+    /**
+     * Gets or sets a value indicating whether the course is featured on the storefront.
+     */
+    featured?: boolean;
     /**
      * Gets or sets a value indicating whether the scheduled session has availability.
      */
@@ -1303,6 +1391,7 @@ export class CoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,
@@ -1312,6 +1401,7 @@ export class CoursesService {
         RemainingUsesGTE: remainingUsesGte,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         HasAvailability: hasAvailability,
         OrderFirstNameContains: orderFirstNameContains,
         OrderLastNameContains: orderLastNameContains,
@@ -1358,6 +1448,7 @@ export class CoursesService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     bookingStatus,
     startDateTimeLte,
     startDateTimeGte,
@@ -1367,6 +1458,7 @@ export class CoursesService {
     remainingUsesGte,
     futureOnly,
     online,
+    featured,
     hasAvailability,
     orderFirstNameContains,
     orderLastNameContains,
@@ -1432,6 +1524,10 @@ export class CoursesService {
      * Gets or sets a value indicating this an openactive reaquest.
      */
     openActiveUpdate?: boolean;
+    /**
+     * Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
+     */
+    dashboardRequest?: boolean;
     /**
      * Gets or sets the queryable booking status.
      */
@@ -1468,6 +1564,10 @@ export class CoursesService {
      * Gets or sets a value indicating whether return online courses.
      */
     online?: boolean;
+    /**
+     * Gets or sets a value indicating whether the course is featured on the storefront.
+     */
+    featured?: boolean;
     /**
      * Gets or sets a value indicating whether the scheduled session has availability.
      */
@@ -1564,6 +1664,7 @@ export class CoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,
@@ -1573,6 +1674,7 @@ export class CoursesService {
         RemainingUsesGTE: remainingUsesGte,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         HasAvailability: hasAvailability,
         OrderFirstNameContains: orderFirstNameContains,
         OrderLastNameContains: orderLastNameContains,

package/src/services/GenericActivityService.ts

@@ -146,6 +146,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -215,6 +216,10 @@ export class GenericActivityService {
      * Gets or sets a value indicating whether to inlcude the activities next availability.
      */
     includeNextOpportunity?: boolean;
+    /**
+     * Gets or sets a value indicating whether to filter on whether the activity is featured.
+     */
+    featured?: boolean;
     /**
      * Gets or sets SearchGeoCenter.
      */
@@ -357,6 +362,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -440,6 +446,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -509,6 +516,10 @@ export class GenericActivityService {
      * Gets or sets a value indicating whether to inlcude the activities next availability.
      */
     includeNextOpportunity?: boolean;
+    /**
+     * Gets or sets a value indicating whether to filter on whether the activity is featured.
+     */
+    featured?: boolean;
     /**
      * Gets or sets SearchGeoCenter.
      */
@@ -651,6 +662,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -707,6 +719,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -776,6 +789,10 @@ export class GenericActivityService {
      * Gets or sets a value indicating whether to inlcude the activities next availability.
      */
     includeNextOpportunity?: boolean;
+    /**
+     * Gets or sets a value indicating whether to filter on whether the activity is featured.
+     */
+    featured?: boolean;
     /**
      * Gets or sets SearchGeoCenter.
      */
@@ -918,6 +935,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -974,6 +992,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -1043,6 +1062,10 @@ export class GenericActivityService {
      * Gets or sets a value indicating whether to inlcude the activities next availability.
      */
     includeNextOpportunity?: boolean;
+    /**
+     * Gets or sets a value indicating whether to filter on whether the activity is featured.
+     */
+    featured?: boolean;
     /**
      * Gets or sets SearchGeoCenter.
      */
@@ -1185,6 +1208,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -1241,6 +1265,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -1310,6 +1335,10 @@ export class GenericActivityService {
      * Gets or sets a value indicating whether to inlcude the activities next availability.
      */
     includeNextOpportunity?: boolean;
+    /**
+     * Gets or sets a value indicating whether to filter on whether the activity is featured.
+     */
+    featured?: boolean;
     /**
      * Gets or sets SearchGeoCenter.
      */
@@ -1452,6 +1481,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,