reach-api-sdk 1.0.191 → 1.0.193

package/src/definition/swagger.yaml

@@ -4330,6 +4330,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -4559,6 +4565,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -5122,6 +5134,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -5526,6 +5544,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -5752,6 +5776,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -5984,6 +6014,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -8198,7 +8234,7 @@ paths:
     patch:
       tags:
         - Courses
-      summary: Asign deal to course />.
+      summary: Assign deal to course />.
       operationId: AssignDeal
       parameters:
         - name: courseId
@@ -8268,7 +8304,7 @@ paths:
     patch:
       tags:
         - Courses
-      summary: Unasign deal from course />.
+      summary: Unassign deal from course />.
       operationId: UnassignDeal
       parameters:
         - name: courseId
@@ -8334,6 +8370,132 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  '/api/courses/{id}/set-featured':
+    patch:
+      tags:
+        - Courses
+      summary: Set the course as featured (displays more prominently on the storefront).
+      operationId: SetFeatured
+      parameters:
+        - name: id
+          in: path
+          description: The course Id.
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/Course'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Course'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/Course'
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+  '/api/courses/{id}/remove-featured':
+    patch:
+      tags:
+        - Courses
+      summary: Remove the course as featured (displays as standard on the storefront).
+      operationId: RemoveFeatured
+      parameters:
+        - name: id
+          in: path
+          description: The course Id.
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/Course'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Course'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/Course'
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
   /api/courses/v2-temporary-route:
     post:
       tags:
@@ -8740,6 +8902,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: BookingStatus
           in: query
           description: Gets or sets the queryable booking status.
@@ -8791,6 +8958,11 @@ paths:
           description: Gets or sets a value indicating whether return online courses.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the course is featured on the storefront.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -9204,6 +9376,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: BookingStatus
           in: query
           description: Gets or sets the queryable booking status.
@@ -9255,6 +9432,11 @@ paths:
           description: Gets or sets a value indicating whether return online courses.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the course is featured on the storefront.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -9490,6 +9672,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: BookingStatus
           in: query
           description: Gets or sets the queryable booking status.
@@ -9541,6 +9728,11 @@ paths:
           description: Gets or sets a value indicating whether return online courses.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the course is featured on the storefront.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -9782,6 +9974,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: BookingStatus
           in: query
           description: Gets or sets the queryable booking status.
@@ -9833,6 +10030,11 @@ paths:
           description: Gets or sets a value indicating whether return online courses.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the course is featured on the storefront.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -23624,6 +23826,11 @@ paths:
           description: Gets or sets a value indicating whether to inlcude the activities next availability.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether to filter on whether the activity is featured.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -23988,6 +24195,11 @@ paths:
           description: Gets or sets a value indicating whether to inlcude the activities next availability.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether to filter on whether the activity is featured.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -24283,6 +24495,11 @@ paths:
           description: Gets or sets a value indicating whether to inlcude the activities next availability.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether to filter on whether the activity is featured.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -24578,6 +24795,11 @@ paths:
           description: Gets or sets a value indicating whether to inlcude the activities next availability.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether to filter on whether the activity is featured.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -24879,6 +25101,11 @@ paths:
           description: Gets or sets a value indicating whether to inlcude the activities next availability.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether to filter on whether the activity is featured.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -28779,6 +29006,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -29177,6 +29410,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -29397,6 +29636,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -29623,6 +29868,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -40432,6 +40683,17 @@ paths:
           description: Gets or sets the queryable event timing.
           schema:
             $ref: '#/components/schemas/EventTiming'
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -40791,6 +41053,17 @@ paths:
           description: Gets or sets the queryable event timing.
           schema:
             $ref: '#/components/schemas/EventTiming'
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -40972,6 +41245,17 @@ paths:
           description: Gets or sets the queryable event timing.
           schema:
             $ref: '#/components/schemas/EventTiming'
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -41159,6 +41443,17 @@ paths:
           description: Gets or sets the queryable event timing.
           schema:
             $ref: '#/components/schemas/EventTiming'
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -42413,6 +42708,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -42811,6 +43112,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -43031,6 +43338,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -43257,6 +43570,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -53071,6 +53390,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -53426,6 +53751,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -53540,6 +53871,75 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  /api/public/calendar:
+    get:
+      tags:
+        - PublicCalendar
+      summary: Gets calendar data.
+      operationId: GetCalendarView
+      parameters:
+        - name: x-tenant-subdomain
+          in: header
+          description: The tenants subdomain.
+          schema:
+            type: string
+        - name: StartDateTimeGTE
+          in: query
+          description: Gets or sets the queryable calendar item start date time is greater than or equal to.
+          schema:
+            type: string
+            format: date-time
+        - name: VenueId
+          in: query
+          description: Gets or sets the venue Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
+        - name: ProgrammeId
+          in: query
+          description: Gets or sets the programme Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: OK
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
   '/api/public/courses/{id}':
     get:
       tags:
@@ -53735,6 +54135,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: BookingStatus
           in: query
           description: Gets or sets the queryable booking status.
@@ -53786,6 +54191,11 @@ paths:
           description: Gets or sets a value indicating whether return online courses.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the course is featured on the storefront.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -54318,6 +54728,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: BookingStatus
           in: query
           description: Gets or sets the queryable booking status.
@@ -54369,6 +54784,11 @@ paths:
           description: Gets or sets a value indicating whether return online courses.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the course is featured on the storefront.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -56259,6 +56679,11 @@ paths:
           description: Gets or sets a value indicating whether to inlcude the activities next availability.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether to filter on whether the activity is featured.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -56554,6 +56979,11 @@ paths:
           description: Gets or sets a value indicating whether to inlcude the activities next availability.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether to filter on whether the activity is featured.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -56854,6 +57284,11 @@ paths:
           description: Gets or sets a value indicating whether to inlcude the activities next availability.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether to filter on whether the activity is featured.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -57246,6 +57681,11 @@ paths:
           description: Gets or sets a value indicating whether to inlcude the activities next availability.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether to filter on whether the activity is featured.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -58265,6 +58705,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -58490,6 +58936,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -58653,6 +59105,11 @@ paths:
           description: Gets or sets a value indicating whether return online sessions.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the session is featured on the storefront.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -58684,6 +59141,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: NetworkId
           in: query
           description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -59884,6 +60346,17 @@ paths:
           description: Gets or sets the queryable event timing.
           schema:
             $ref: '#/components/schemas/EventTiming'
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -60561,6 +61034,17 @@ paths:
           description: Gets or sets the queryable event timing.
           schema:
             $ref: '#/components/schemas/EventTiming'
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -60905,6 +61389,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -61741,6 +62231,12 @@ paths:
           schema:
             type: string
             format: date-time
+        - name: EndUserIdentityId
+          in: query
+          description: Gets or sets the end user identity Id for use in a query search.
+          schema:
+            type: string
+            format: uuid
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -64670,6 +65166,11 @@ paths:
           description: Gets or sets a value indicating whether to only return future scheduled session.
           schema:
             type: boolean
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return bookable scheduled sessions.
+          schema:
+            type: boolean
         - name: IncludeImages
           in: query
           description: Gets or sets a value indicating whether to include image detail in the results.
@@ -65231,6 +65732,11 @@ paths:
           description: Gets or sets a value indicating whether to only return future scheduled session.
           schema:
             type: boolean
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return bookable scheduled sessions.
+          schema:
+            type: boolean
         - name: IncludeImages
           in: query
           description: Gets or sets a value indicating whether to include image detail in the results.
@@ -65563,6 +66069,11 @@ paths:
           description: Gets or sets a value indicating whether return online sessions.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the session is featured on the storefront.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -65594,6 +66105,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: NetworkId
           in: query
           description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -66049,6 +66565,11 @@ paths:
           description: Gets or sets a value indicating whether to only return future scheduled session.
           schema:
             type: boolean
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return bookable scheduled sessions.
+          schema:
+            type: boolean
         - name: IncludeImages
           in: query
           description: Gets or sets a value indicating whether to include image detail in the results.
@@ -66482,6 +67003,11 @@ paths:
           description: Gets or sets a value indicating whether return online sessions.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the session is featured on the storefront.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -66513,6 +67039,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: NetworkId
           in: query
           description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -71277,6 +71808,11 @@ paths:
           schema:
             type: number
             format: float
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -71558,6 +72094,11 @@ paths:
           schema:
             type: number
             format: float
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -72012,6 +72553,11 @@ paths:
           schema:
             type: number
             format: float
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -78164,6 +78710,11 @@ paths:
           description: Gets or sets a value indicating whether to only return future scheduled session.
           schema:
             type: boolean
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return bookable scheduled sessions.
+          schema:
+            type: boolean
         - name: IncludeImages
           in: query
           description: Gets or sets a value indicating whether to include image detail in the results.
@@ -78606,6 +79157,11 @@ paths:
           description: Gets or sets a value indicating whether to only return future scheduled session.
           schema:
             type: boolean
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return bookable scheduled sessions.
+          schema:
+            type: boolean
         - name: IncludeImages
           in: query
           description: Gets or sets a value indicating whether to include image detail in the results.
@@ -78870,6 +79426,11 @@ paths:
           description: Gets or sets a value indicating whether to only return future scheduled session.
           schema:
             type: boolean
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return bookable scheduled sessions.
+          schema:
+            type: boolean
         - name: IncludeImages
           in: query
           description: Gets or sets a value indicating whether to include image detail in the results.
@@ -79140,6 +79701,11 @@ paths:
           description: Gets or sets a value indicating whether to only return future scheduled session.
           schema:
             type: boolean
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return bookable scheduled sessions.
+          schema:
+            type: boolean
         - name: IncludeImages
           in: query
           description: Gets or sets a value indicating whether to include image detail in the results.
@@ -79858,6 +80424,11 @@ paths:
             type: array
             items:
               $ref: '#/components/schemas/ScheduleStatus'
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return course sessions contained in bookable courses.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -80189,6 +80760,11 @@ paths:
             type: array
             items:
               $ref: '#/components/schemas/ScheduleStatus'
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return course sessions contained in bookable courses.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -80342,6 +80918,11 @@ paths:
             type: array
             items:
               $ref: '#/components/schemas/ScheduleStatus'
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return course sessions contained in bookable courses.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -80501,6 +81082,11 @@ paths:
             type: array
             items:
               $ref: '#/components/schemas/ScheduleStatus'
+        - name: BookableOnly
+          in: query
+          description: Gets or sets a value indicating whether to only return course sessions contained in bookable courses.
+          schema:
+            type: boolean
         - name: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -81069,12 +81655,12 @@ paths:
     patch:
       tags:
         - Sessions
-      summary: Asign deal to session />.
+      summary: Assign deal to session.
       operationId: AssignDeal
       parameters:
         - name: sessionId
           in: path
-          description: The course Id.
+          description: The session Id.
           required: true
           schema:
             type: string
@@ -81139,12 +81725,12 @@ paths:
     patch:
       tags:
         - Sessions
-      summary: Unasign deal from session />.
+      summary: Unassign deal from session.
       operationId: UnassignDeal
       parameters:
         - name: sessionId
           in: path
-          description: The course Id.
+          description: The session Id.
           required: true
           schema:
             type: string
@@ -81205,6 +81791,132 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  '/api/sessions/{id}/set-featured':
+    patch:
+      tags:
+        - Sessions
+      summary: Set the session as featured (displays more prominently on the storefront).
+      operationId: SetFeatured
+      parameters:
+        - name: id
+          in: path
+          description: The session Id.
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/Session'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Session'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/Session'
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+  '/api/sessions/{id}/remove-featured':
+    patch:
+      tags:
+        - Sessions
+      summary: Remove the session as featured (displays as standard on the storefront).
+      operationId: RemoveFeatured
+      parameters:
+        - name: id
+          in: path
+          description: The session Id.
+          required: true
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/Session'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Session'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/Session'
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
   /api/sessions/v2-temporary-route:
     post:
       tags:
@@ -81589,6 +82301,11 @@ paths:
           description: Gets or sets a value indicating whether return online sessions.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the session is featured on the storefront.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -81620,6 +82337,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: NetworkId
           in: query
           description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -82055,6 +82777,11 @@ paths:
           description: Gets or sets a value indicating whether return online sessions.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the session is featured on the storefront.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -82086,6 +82813,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: NetworkId
           in: query
           description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -82343,6 +83075,11 @@ paths:
           description: Gets or sets a value indicating whether return online sessions.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the session is featured on the storefront.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -82374,6 +83111,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: NetworkId
           in: query
           description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -82637,6 +83379,11 @@ paths:
           description: Gets or sets a value indicating whether return online sessions.
           schema:
             type: boolean
+        - name: Featured
+          in: query
+          description: Gets or sets a value indicating whether the session is featured on the storefront.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -82668,6 +83415,11 @@ paths:
           description: Gets or sets a value indicating this an openactive reaquest.
           schema:
             type: boolean
+        - name: DashboardRequest
+          in: query
+          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: NetworkId
           in: query
           description: Gets or sets a value indicating whether to include only sessions by given NetworkId.
@@ -113405,6 +114157,11 @@ paths:
           schema:
             type: number
             format: float
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -113802,6 +114559,11 @@ paths:
           schema:
             type: number
             format: float
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -114021,6 +114783,11 @@ paths:
           schema:
             type: number
             format: float
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -114246,6 +115013,11 @@ paths:
           schema:
             type: number
             format: float
+        - name: DashboardRequest
+          in: query
+          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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -121390,6 +122162,10 @@ components:
           type: string
           description: Gets or sets the admin contact email.
           nullable: true
+        sendReminder:
+          type: boolean
+          description: Gets or sets a valu indicating whether to send the reminder email.
+          nullable: true
         reminderHoursBeforeStart:
           type: integer
           description: Gets or sets the reminder hours before start.
@@ -121401,6 +122177,10 @@ components:
           type: string
           description: Gets or sets the booking link override if checkout will occur externally.
           nullable: true
+        featured:
+          type: boolean
+          description: Gets or sets a value indicating whether the activity should be featured on the storefront.
+          default: false
         computedImage:
           type: string
           description: Gets the computed image url.
@@ -124623,6 +125403,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether there is an age restriction.
           default: false
+        featured:
+          type: boolean
+          description: Gets or sets a value indicating whether the activity should be featured on the storefront.
+          default: false
         startDateTime:
           type: string
           description: Gets or sets the start date.
@@ -130252,6 +131036,10 @@ components:
           type: string
           description: Gets or sets the admin contact email.
           nullable: true
+        sendReminder:
+          type: boolean
+          description: Gets or sets a valu indicating whether to send the reminder email.
+          nullable: true
         reminderHoursBeforeStart:
           type: integer
           description: Gets or sets the reminder hours before start.
@@ -130263,6 +131051,10 @@ components:
           type: string
           description: Gets or sets the booking link override if checkout will occur externally.
           nullable: true
+        featured:
+          type: boolean
+          description: Gets or sets a value indicating whether the activity should be featured on the storefront.
+          default: false
         computedImage:
           type: string
           description: Gets the computed image url.
@@ -134087,6 +134879,8 @@ components:
           type: string
           description: Gets or sets the tenants website marketing optin text.
           nullable: true
+        upcomingLayout:
+          $ref: '#/components/schemas/UpcomingLayout'
       additionalProperties: false
       description: Represents an organisation within the Reach application.
     TenantWebsiteSettingPage:
@@ -134336,6 +135130,12 @@ components:
           nullable: true
       additionalProperties: false
       description: The OpenAI description completion response model.
+    UpcomingLayout:
+      enum:
+        - Grid
+        - Calendar
+      type: string
+      description: UpcomingLayout.
     UpdateEmailSettings:
       type: object
       properties: