reach-api-sdk 1.0.192 → 1.0.194

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.
    */
@@ -288,6 +292,10 @@ export type Course = {
    * 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 the courses total number of sessions.
+   */
+  readonly totalSessions?: number;
   /**
    * Gets the courses period label.
    */

package/src/models/CreateDeal.ts

@@ -71,4 +71,12 @@ export type CreateDeal = {
    * Gets the venues shortened formatted address.
    */
   readonly typeLabel?: string | null;
+  /**
+   * Gets a value indicating whether the deal is a promotional deal (manually entered by the user).
+   */
+  readonly isPromotional?: boolean;
+  /**
+   * Gets the user-friendly label for the deal type.
+   */
+  readonly typeDisplayName?: string | null;
 };

package/src/models/Deal.ts

@@ -71,4 +71,12 @@ export type Deal = {
    * Gets the venues shortened formatted address.
    */
   readonly typeLabel?: string | null;
+  /**
+   * Gets a value indicating whether the deal is a promotional deal (manually entered by the user).
+   */
+  readonly isPromotional?: boolean;
+  /**
+   * Gets the user-friendly label for the deal type.
+   */
+  readonly typeDisplayName?: string | null;
 };

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.
    */

package/src/services/CourseSessionsService.ts

@@ -244,6 +244,7 @@ export class CourseSessionsService {
     endDateTimeGte,
     futureOnly,
     includeVenue,
+    includeOffers,
     excludeArchived,
     pageNumber,
     take,
@@ -313,6 +314,10 @@ export class CourseSessionsService {
      * Gets or sets a value indicating whether to include venue detail in the results.
      */
     includeVenue?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include offer detail in the results.
+     */
+    includeOffers?: boolean;
     /**
      * Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
      */
@@ -380,6 +385,7 @@ export class CourseSessionsService {
         EndDateTimeGTE: endDateTimeGte,
         FutureOnly: futureOnly,
         IncludeVenue: includeVenue,
+        IncludeOffers: includeOffers,
         ExcludeArchived: excludeArchived,
         PageNumber: pageNumber,
         Take: take,
@@ -502,6 +508,7 @@ export class CourseSessionsService {
     endDateTimeGte,
     futureOnly,
     includeVenue,
+    includeOffers,
     excludeArchived,
     pageNumber,
     take,
@@ -571,6 +578,10 @@ export class CourseSessionsService {
      * Gets or sets a value indicating whether to include venue detail in the results.
      */
     includeVenue?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include offer detail in the results.
+     */
+    includeOffers?: boolean;
     /**
      * Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
      */
@@ -638,6 +649,7 @@ export class CourseSessionsService {
         EndDateTimeGTE: endDateTimeGte,
         FutureOnly: futureOnly,
         IncludeVenue: includeVenue,
+        IncludeOffers: includeOffers,
         ExcludeArchived: excludeArchived,
         PageNumber: pageNumber,
         Take: take,
@@ -679,6 +691,7 @@ export class CourseSessionsService {
     endDateTimeGte,
     futureOnly,
     includeVenue,
+    includeOffers,
     excludeArchived,
     pageNumber,
     take,
@@ -748,6 +761,10 @@ export class CourseSessionsService {
      * Gets or sets a value indicating whether to include venue detail in the results.
      */
     includeVenue?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include offer detail in the results.
+     */
+    includeOffers?: boolean;
     /**
      * Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
      */
@@ -815,6 +832,7 @@ export class CourseSessionsService {
         EndDateTimeGTE: endDateTimeGte,
         FutureOnly: futureOnly,
         IncludeVenue: includeVenue,
+        IncludeOffers: includeOffers,
         ExcludeArchived: excludeArchived,
         PageNumber: pageNumber,
         Take: take,
@@ -856,6 +874,7 @@ export class CourseSessionsService {
     endDateTimeGte,
     futureOnly,
     includeVenue,
+    includeOffers,
     excludeArchived,
     pageNumber,
     take,
@@ -925,6 +944,10 @@ export class CourseSessionsService {
      * Gets or sets a value indicating whether to include venue detail in the results.
      */
     includeVenue?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include offer detail in the results.
+     */
+    includeOffers?: boolean;
     /**
      * Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
      */
@@ -992,6 +1015,7 @@ export class CourseSessionsService {
         EndDateTimeGTE: endDateTimeGte,
         FutureOnly: futureOnly,
         IncludeVenue: includeVenue,
+        IncludeOffers: includeOffers,
         ExcludeArchived: excludeArchived,
         PageNumber: pageNumber,
         Take: take,

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,
@@ -569,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.
      */
@@ -705,6 +764,7 @@ export class CoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,
@@ -842,6 +902,7 @@ export class CoursesService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     bookingStatus,
     startDateTimeLte,
     startDateTimeGte,
@@ -917,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.
      */
@@ -1053,6 +1118,7 @@ export class CoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,
@@ -1109,6 +1175,7 @@ export class CoursesService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     bookingStatus,
     startDateTimeLte,
     startDateTimeGte,
@@ -1184,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.
      */
@@ -1320,6 +1391,7 @@ export class CoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,
@@ -1376,6 +1448,7 @@ export class CoursesService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     bookingStatus,
     startDateTimeLte,
     startDateTimeGte,
@@ -1451,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.
      */
@@ -1587,6 +1664,7 @@ export class CoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,

package/src/services/GenericActivityService.ts

@@ -146,6 +146,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -167,6 +168,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -215,6 +217,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.
      */
@@ -299,6 +305,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets the Programme ids.
+     */
+    programmeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -357,6 +367,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -378,6 +389,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -440,6 +452,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -461,6 +474,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -509,6 +523,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.
      */
@@ -593,6 +611,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets the Programme ids.
+     */
+    programmeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -651,6 +673,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -672,6 +695,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -707,6 +731,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -728,6 +753,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -776,6 +802,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.
      */
@@ -860,6 +890,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets the Programme ids.
+     */
+    programmeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -918,6 +952,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -939,6 +974,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -974,6 +1010,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -995,6 +1032,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -1043,6 +1081,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.
      */
@@ -1127,6 +1169,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets the Programme ids.
+     */
+    programmeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -1185,6 +1231,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -1206,6 +1253,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -1241,6 +1289,7 @@ export class GenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -1262,6 +1311,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -1310,6 +1360,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.
      */
@@ -1394,6 +1448,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets the Programme ids.
+     */
+    programmeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -1452,6 +1510,7 @@ export class GenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -1473,6 +1532,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,