reach-api-sdk 1.0.193 → 1.0.194

package/src/definition/swagger.yaml

@@ -10829,6 +10829,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: ExcludeArchived
           in: query
           description: Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
@@ -11219,6 +11224,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: ExcludeArchived
           in: query
           description: Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
@@ -11431,6 +11441,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: ExcludeArchived
           in: query
           description: Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
@@ -11649,6 +11664,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: ExcludeArchived
           in: query
           description: Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
@@ -23957,6 +23977,14 @@ paths:
             items:
               type: integer
               format: int32
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the Programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -24326,6 +24354,14 @@ paths:
             items:
               type: integer
               format: int32
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the Programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -24626,6 +24662,14 @@ paths:
             items:
               type: integer
               format: int32
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the Programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -24926,6 +24970,14 @@ paths:
             items:
               type: integer
               format: int32
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the Programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -25232,6 +25284,14 @@ paths:
             items:
               type: integer
               format: int32
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the Programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -53878,7 +53938,7 @@ paths:
       summary: Gets calendar data.
       operationId: GetCalendarView
       parameters:
-        - name: x-tenant-subdomain
+        - name: x_tenant_subdomain
           in: header
           description: The tenants subdomain.
           schema:
@@ -56810,6 +56870,14 @@ paths:
             items:
               type: integer
               format: int32
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the Programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -57110,6 +57178,14 @@ paths:
             items:
               type: integer
               format: int32
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the Programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -57415,6 +57491,14 @@ paths:
             items:
               type: integer
               format: int32
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the Programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -57812,6 +57896,14 @@ paths:
             items:
               type: integer
               format: int32
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the Programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -65181,6 +65273,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: IncludeOrders
           in: query
           description: Gets or sets a value indicating whether to include order detail in the results.
@@ -65747,6 +65844,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: IncludeOrders
           in: query
           description: Gets or sets a value indicating whether to include order detail in the results.
@@ -66580,6 +66682,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: IncludeOrders
           in: query
           description: Gets or sets a value indicating whether to include order detail in the results.
@@ -71813,6 +71920,14 @@ paths:
           description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
           schema:
             type: boolean
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -72099,6 +72214,14 @@ paths:
           description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
           schema:
             type: boolean
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -72558,6 +72681,14 @@ paths:
           description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
           schema:
             type: boolean
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -78725,6 +78856,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: IncludeOrders
           in: query
           description: Gets or sets a value indicating whether to include order detail in the results.
@@ -79172,6 +79308,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: IncludeOrders
           in: query
           description: Gets or sets a value indicating whether to include order detail in the results.
@@ -79441,6 +79582,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: IncludeOrders
           in: query
           description: Gets or sets a value indicating whether to include order detail in the results.
@@ -79716,6 +79862,11 @@ paths:
           description: Gets or sets a value indicating whether to include venue detail in the results.
           schema:
             type: boolean
+        - name: IncludeOffers
+          in: query
+          description: Gets or sets a value indicating whether to include offer detail in the results.
+          schema:
+            type: boolean
         - name: IncludeOrders
           in: query
           description: Gets or sets a value indicating whether to include order detail in the results.
@@ -114162,6 +114313,14 @@ paths:
           description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
           schema:
             type: boolean
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -114564,6 +114723,14 @@ paths:
           description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
           schema:
             type: boolean
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -114788,6 +114955,14 @@ paths:
           description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
           schema:
             type: boolean
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -115018,6 +115193,14 @@ paths:
           description: Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
           schema:
             type: boolean
+        - name: ProgrammeIds
+          in: query
+          description: Gets or sets the programme ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -122315,6 +122498,12 @@ components:
           format: int32
           nullable: true
           readOnly: true
+        totalSessions:
+          type: integer
+          description: Gets the courses total number of sessions.
+          format: int32
+          default: 0
+          readOnly: true
         timePeriodLabel:
           type: string
           description: Gets the courses period label.
@@ -123253,6 +123442,16 @@ components:
           description: Gets the venues shortened formatted address.
           nullable: true
           readOnly: true
+        isPromotional:
+          type: boolean
+          description: Gets a value indicating whether the deal is a promotional deal (manually entered by the user).
+          default: false
+          readOnly: true
+        typeDisplayName:
+          type: string
+          description: Gets the user-friendly label for the deal type.
+          nullable: true
+          readOnly: true
       additionalProperties: false
       description: Post model for session deals.
     CreateEmailSettings:
@@ -124202,6 +124401,16 @@ components:
           description: Gets the venues shortened formatted address.
           nullable: true
           readOnly: true
+        isPromotional:
+          type: boolean
+          description: Gets a value indicating whether the deal is a promotional deal (manually entered by the user).
+          default: false
+          readOnly: true
+        typeDisplayName:
+          type: string
+          description: Gets the user-friendly label for the deal type.
+          nullable: true
+          readOnly: true
       additionalProperties: false
       description: Represents a deal within the Reach application.
     DealActivity:

package/src/models/Course.ts

@@ -292,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/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/GenericActivityService.ts

@@ -168,6 +168,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -304,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.
      */
@@ -384,6 +389,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -468,6 +474,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -604,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.
      */
@@ -684,6 +695,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -741,6 +753,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -877,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.
      */
@@ -957,6 +974,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -1014,6 +1032,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -1150,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.
      */
@@ -1230,6 +1253,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -1287,6 +1311,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -1423,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.
      */
@@ -1503,6 +1532,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,

package/src/services/PublicCalendarService.ts

@@ -40,7 +40,7 @@ export class PublicCalendarService {
       method: 'GET',
       url: '/api/public/calendar',
       headers: {
-        'x-tenant-subdomain': xTenantSubdomain,
+        x_tenant_subdomain: xTenantSubdomain,
       },
       query: {
         StartDateTimeGTE: startDateTimeGte,