reach-api-sdk 1.0.192 → 1.0.193

package/src/definition/swagger.yaml

@@ -8234,7 +8234,7 @@ paths:
     patch:
       tags:
         - Courses
-      summary: Asign deal to course />.
+      summary: Assign deal to course />.
       operationId: AssignDeal
       parameters:
         - name: courseId
@@ -8304,7 +8304,7 @@ paths:
     patch:
       tags:
         - Courses
-      summary: Unasign deal from course />.
+      summary: Unassign deal from course />.
       operationId: UnassignDeal
       parameters:
         - name: courseId
@@ -8370,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:
@@ -8776,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.
@@ -9245,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.
@@ -9536,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.
@@ -9833,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.
@@ -23680,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.
@@ -24044,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.
@@ -24339,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.
@@ -24634,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.
@@ -24935,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.
@@ -40518,6 +40689,11 @@ paths:
           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.
@@ -40883,6 +41059,11 @@ paths:
           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.
@@ -41070,6 +41251,11 @@ paths:
           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.
@@ -41263,6 +41449,11 @@ paths:
           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.
@@ -53944,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.
@@ -54532,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.
@@ -56478,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.
@@ -56773,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.
@@ -57073,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.
@@ -57465,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.
@@ -58920,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.
@@ -60126,6 +60352,11 @@ paths:
           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.
@@ -60809,6 +61040,11 @@ paths:
           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.
@@ -65869,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.
@@ -66798,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.
@@ -71562,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.
@@ -71843,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.
@@ -72297,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.
@@ -81394,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
@@ -81464,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
@@ -81530,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:
@@ -81950,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.
@@ -82421,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.
@@ -82714,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.
@@ -83013,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.
@@ -113750,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.
@@ -114147,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.
@@ -114366,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.
@@ -114591,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.
@@ -121735,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.
@@ -124972,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.
@@ -130601,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.