reach-api-sdk 1.0.192 → 1.0.193

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

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/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,
@@ -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,

package/src/services/OrderItemsService.ts

@@ -204,6 +204,7 @@ export class OrderItemsService {
     orderByOpportunityStartdate,
     eventTiming,
     endUserIdentityId,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -260,6 +261,10 @@ export class OrderItemsService {
      * Gets or sets the end user identity Id for use in a query search.
      */
     endUserIdentityId?: string;
+    /**
+     * 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 page number for paged queries.
      */
@@ -320,6 +325,7 @@ export class OrderItemsService {
         OrderByOpportunityStartdate: orderByOpportunityStartdate,
         EventTiming: eventTiming,
         EndUserIdentityId: endUserIdentityId,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -438,6 +444,7 @@ export class OrderItemsService {
     orderByOpportunityStartdate,
     eventTiming,
     endUserIdentityId,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -494,6 +501,10 @@ export class OrderItemsService {
      * Gets or sets the end user identity Id for use in a query search.
      */
     endUserIdentityId?: string;
+    /**
+     * 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 page number for paged queries.
      */
@@ -554,6 +565,7 @@ export class OrderItemsService {
         OrderByOpportunityStartdate: orderByOpportunityStartdate,
         EventTiming: eventTiming,
         EndUserIdentityId: endUserIdentityId,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -591,6 +603,7 @@ export class OrderItemsService {
     orderByOpportunityStartdate,
     eventTiming,
     endUserIdentityId,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -647,6 +660,10 @@ export class OrderItemsService {
      * Gets or sets the end user identity Id for use in a query search.
      */
     endUserIdentityId?: string;
+    /**
+     * 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 page number for paged queries.
      */
@@ -707,6 +724,7 @@ export class OrderItemsService {
         OrderByOpportunityStartdate: orderByOpportunityStartdate,
         EventTiming: eventTiming,
         EndUserIdentityId: endUserIdentityId,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -744,6 +762,7 @@ export class OrderItemsService {
     orderByOpportunityStartdate,
     eventTiming,
     endUserIdentityId,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -800,6 +819,10 @@ export class OrderItemsService {
      * Gets or sets the end user identity Id for use in a query search.
      */
     endUserIdentityId?: string;
+    /**
+     * 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 page number for paged queries.
      */
@@ -860,6 +883,7 @@ export class OrderItemsService {
         OrderByOpportunityStartdate: orderByOpportunityStartdate,
         EventTiming: eventTiming,
         EndUserIdentityId: endUserIdentityId,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,

package/src/services/PublicCoursesService.ts

@@ -96,6 +96,7 @@ export class PublicCoursesService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     bookingStatus,
     startDateTimeLte,
     startDateTimeGte,
@@ -172,6 +173,10 @@ export class PublicCoursesService {
      * 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.
      */
@@ -311,6 +316,7 @@ export class PublicCoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,
@@ -504,6 +510,7 @@ export class PublicCoursesService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     bookingStatus,
     startDateTimeLte,
     startDateTimeGte,
@@ -583,6 +590,10 @@ export class PublicCoursesService {
      * 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.
      */
@@ -722,6 +733,7 @@ export class PublicCoursesService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         BookingStatus: bookingStatus,
         StartDateTimeLTE: startDateTimeLte,
         StartDateTimeGTE: startDateTimeGte,

package/src/services/PublicGenericActivityService.ts

@@ -59,6 +59,7 @@ export class PublicGenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -129,6 +130,10 @@ export class PublicGenericActivityService {
      * 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.
      */
@@ -274,6 +279,7 @@ export class PublicGenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -330,6 +336,7 @@ export class PublicGenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -399,6 +406,10 @@ export class PublicGenericActivityService {
      * 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.
      */
@@ -541,6 +552,7 @@ export class PublicGenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -598,6 +610,7 @@ export class PublicGenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -671,6 +684,10 @@ export class PublicGenericActivityService {
      * 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.
      */
@@ -816,6 +833,7 @@ export class PublicGenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,
@@ -918,6 +936,7 @@ export class PublicGenericActivityService {
     deleted,
     activityType,
     includeNextOpportunity,
+    featured,
     searchGeoCenter,
     openactiveActivityId,
     activityId,
@@ -991,6 +1010,10 @@ export class PublicGenericActivityService {
      * 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.
      */
@@ -1136,6 +1159,7 @@ export class PublicGenericActivityService {
         Deleted: deleted,
         ActivityType: activityType,
         IncludeNextOpportunity: includeNextOpportunity,
+        Featured: featured,
         SearchGeoCenter: searchGeoCenter,
         OpenactiveActivityId: openactiveActivityId,
         ActivityId: activityId,

package/src/services/PublicNetworksService.ts

@@ -34,6 +34,7 @@ export class PublicNetworksService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     networkId,
     distance,
     minAgeLte,
@@ -118,6 +119,10 @@ export class PublicNetworksService {
      * 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 a value indicating whether to include only sessions by given NetworkId.
      */
@@ -245,6 +250,7 @@ export class PublicNetworksService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         NetworkId: networkId,
         Distance: distance,
         MinAgeLTE: minAgeLte,

package/src/services/PublicOrderItemsService.ts

@@ -33,6 +33,7 @@ export class PublicOrderItemsService {
     orderByOpportunityStartdate,
     eventTiming,
     endUserIdentityId,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -90,6 +91,10 @@ export class PublicOrderItemsService {
      * Gets or sets the end user identity Id for use in a query search.
      */
     endUserIdentityId?: string;
+    /**
+     * 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 page number for paged queries.
      */
@@ -153,6 +158,7 @@ export class PublicOrderItemsService {
         OrderByOpportunityStartdate: orderByOpportunityStartdate,
         EventTiming: eventTiming,
         EndUserIdentityId: endUserIdentityId,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -438,6 +444,7 @@ export class PublicOrderItemsService {
     orderByOpportunityStartdate,
     eventTiming,
     endUserIdentityId,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -498,6 +505,10 @@ export class PublicOrderItemsService {
      * Gets or sets the end user identity Id for use in a query search.
      */
     endUserIdentityId?: string;
+    /**
+     * 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 page number for paged queries.
      */
@@ -561,6 +572,7 @@ export class PublicOrderItemsService {
         OrderByOpportunityStartdate: orderByOpportunityStartdate,
         EventTiming: eventTiming,
         EndUserIdentityId: endUserIdentityId,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,