reach-api-sdk 1.0.196 → 1.0.197

package/src/definition/swagger.yaml

@@ -9779,6 +9779,11 @@ paths:
           description: Gets or sets a value indicating whether the course is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or no.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -10253,6 +10258,11 @@ paths:
           description: Gets or sets a value indicating whether the course is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or no.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -10549,6 +10559,11 @@ paths:
           description: Gets or sets a value indicating whether the course is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or no.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -10848,6 +10863,11 @@ paths:
           description: Gets or sets a value indicating whether the course is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or no.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -11150,6 +11170,11 @@ paths:
           description: Gets or sets a value indicating whether the course is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or no.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -26637,6 +26662,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -26731,15 +26761,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -27019,6 +27049,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -27113,15 +27148,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -27332,6 +27367,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -27426,15 +27466,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -27648,6 +27688,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -27742,15 +27787,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -27961,6 +28006,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -28055,15 +28105,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -28280,6 +28330,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -28374,15 +28429,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -60714,6 +60769,11 @@ paths:
           description: Gets or sets a value indicating whether the course is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or no.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -61307,6 +61367,11 @@ paths:
           description: Gets or sets a value indicating whether the course is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or no.
+          schema:
+            type: boolean
         - name: HasAvailability
           in: query
           description: Gets or sets a value indicating whether the scheduled session has availability.
@@ -63202,6 +63267,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -63296,15 +63366,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -63515,6 +63585,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -63609,15 +63684,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -63833,6 +63908,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -63927,15 +64007,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -64243,6 +64323,11 @@ paths:
           description: Gets or sets a value indicating whether to filter on whether the activity is featured.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating does session is private or no.
+          schema:
+            type: boolean
         - name: SearchGeoCenter
           in: query
           description: Gets or sets SearchGeoCenter.
@@ -64337,15 +64422,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -65680,6 +65765,11 @@ paths:
           description: Gets or sets a value indicating whether the session is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or open.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -65769,15 +65859,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -72644,6 +72734,11 @@ paths:
           description: Gets or sets a value indicating whether the session is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or open.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -72733,15 +72828,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -73583,6 +73678,11 @@ paths:
           description: Gets or sets a value indicating whether the session is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or open.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -73672,15 +73772,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -89802,6 +89902,11 @@ paths:
           description: Gets or sets a value indicating whether the session is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or open.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -89891,15 +89996,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -90278,6 +90383,11 @@ paths:
           description: Gets or sets a value indicating whether the session is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or open.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -90367,15 +90477,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -90576,6 +90686,11 @@ paths:
           description: Gets or sets a value indicating whether the session is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or open.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -90665,15 +90780,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -90877,6 +90992,11 @@ paths:
           description: Gets or sets a value indicating whether the session is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or open.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -90966,15 +91086,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -91181,6 +91301,11 @@ paths:
           description: Gets or sets a value indicating whether the session is featured on the storefront.
           schema:
             type: boolean
+        - name: Private
+          in: query
+          description: Gets or sets a value indicating whether the session is private or open.
+          schema:
+            type: boolean
         - name: ProgrammeId
           in: query
           description: Gets or sets the queryable Programme Id.
@@ -91270,15 +91395,15 @@ paths:
           description: Gets or sets TimeOfDay.
           schema:
             type: string
-        - name: DateFrom
+        - name: StartDateTimeGTE
           in: query
-          description: Gets or sets DateFrom.
+          description: Gets or sets StartDateTimeGTE.
           schema:
             type: string
             format: date-time
-        - name: DateTo
+        - name: EndDateTimeLTE
           in: query
-          description: Gets or sets DateTo.
+          description: Gets or sets EndDateTimeLTE.
           schema:
             type: string
             format: date-time
@@ -132347,6 +132472,16 @@ paths:
       responses:
         '200':
           description: OK
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/WaitlistConversionStatsResponseDto'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WaitlistConversionStatsResponseDto'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/WaitlistConversionStatsResponseDto'
         '400':
           description: Bad Request
           content:
@@ -134491,6 +134626,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether there is an age restriction.
           default: false
+        private:
+          type: boolean
+          description: Gets or sets a value indicating whether activity is private or no.
+          default: false
         additionalSupport:
           type: array
           items:
@@ -135065,6 +135204,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether there is an age restriction.
           nullable: true
+        private:
+          type: boolean
+          description: Gets or sets a value indicating whether course is private or no.
+          nullable: true
         online:
           type: boolean
           description: Gets or sets a value indicating whether the course is online and can take bookings.
@@ -135796,6 +135939,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether there is an age restriction.
           default: false
+        private:
+          type: boolean
+          description: Gets or sets a value indicating whether activity is private or no.
+          default: false
         additionalSupport:
           type: array
           items:
@@ -135946,6 +136093,8 @@ components:
           $ref: '#/components/schemas/FieldPermission'
         noAgeRestriction:
           $ref: '#/components/schemas/FieldPermission'
+        private:
+          $ref: '#/components/schemas/FieldPermission'
         additionalSupport:
           $ref: '#/components/schemas/FieldPermission'
         contactName:
@@ -137788,6 +137937,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether there is an age restriction.
           default: false
+        private:
+          type: boolean
+          description: Gets or sets a value indicating whether activity is private or not.
+          default: false
         featured:
           type: boolean
           description: Gets or sets a value indicating whether the activity should be featured on the storefront.
@@ -141581,6 +141734,8 @@ components:
           description: Gets or sets the programmes sort order with 0 as base.
           format: int32
           nullable: true
+        upcomingLayout:
+          $ref: '#/components/schemas/UpcomingLayout'
         tenant:
           $ref: '#/components/schemas/Tenant'
         sessions:
@@ -141623,6 +141778,7 @@ components:
         - id
         - name
         - tenantId
+        - upcomingLayout
       type: object
       properties:
         tenantId:
@@ -141646,6 +141802,8 @@ components:
           description: Gets or sets the programme image url.
           format: uri
           nullable: true
+        upcomingLayout:
+          $ref: '#/components/schemas/UpcomingLayout'
       additionalProperties: false
       description: Post model for programme updates.
     ProgrammePost:
@@ -143391,6 +143549,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether there is an age restriction.
           default: false
+        private:
+          type: boolean
+          description: Gets or sets a value indicating whether activity is private or no.
+          default: false
         additionalSupport:
           type: array
           items:
@@ -143845,6 +144007,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether there is an age restriction.
           nullable: true
+        private:
+          type: boolean
+          description: Gets or sets a value indicating whether session is private or no.
+          nullable: true
         online:
           type: boolean
           description: Gets or sets a value indicating whether the session is online and can take bookings.
@@ -145928,6 +146094,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether there is an age restriction.
           default: false
+        private:
+          type: boolean
+          description: Gets or sets a value indicating whether the activity is private.
+          default: false
         additionalSupport:
           type: array
           items:
@@ -146115,6 +146285,10 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether there is an age restriction.
           default: false
+        private:
+          type: boolean
+          description: Gets or sets a value indicating whether activity is private or no.
+          default: false
         additionalSupport:
           type: array
           items:
@@ -146307,6 +146481,8 @@ components:
           $ref: '#/components/schemas/FieldPermission'
         noAgeRestriction:
           $ref: '#/components/schemas/FieldPermission'
+        private:
+          $ref: '#/components/schemas/FieldPermission'
         additionalSupport:
           $ref: '#/components/schemas/FieldPermission'
         contactName:
@@ -146409,6 +146585,8 @@ components:
           $ref: '#/components/schemas/FieldPermission'
         noAgeRestriction:
           $ref: '#/components/schemas/FieldPermission'
+        private:
+          $ref: '#/components/schemas/FieldPermission'
         additionalSupport:
           $ref: '#/components/schemas/FieldPermission'
         contactName:
@@ -149453,6 +149631,21 @@ components:
           format: uuid
       additionalProperties: false
       description: Post model for WaitlistActivityReport inserts.
+    WaitlistConversionStatsResponseDto:
+      type: object
+      properties:
+        totalWaitlistCount:
+          type: integer
+          format: int32
+          default: 0
+        totalUpcomingWaitlistCount:
+          type: integer
+          format: int32
+          default: 0
+        conversionPercentage:
+          type: number
+          format: float
+      additionalProperties: false
     WaitlistOpportunity:
       required:
         - dateCreated