reach-api-sdk 1.0.191 → 1.0.192

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.
@@ -8791,6 +8827,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.
@@ -9255,6 +9296,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.
@@ -9541,6 +9587,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.
@@ -9833,6 +9884,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.
@@ -28779,6 +28835,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 +29239,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 +29465,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 +29697,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 +40512,12 @@ 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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -40791,6 +40877,12 @@ 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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -40972,6 +41064,12 @@ 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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -41159,6 +41257,12 @@ 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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -42413,6 +42517,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 +42921,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 +43147,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 +43379,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 +53199,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 +53560,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 +53680,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:
@@ -53786,6 +53995,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.
@@ -54369,6 +54583,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.
@@ -58265,6 +58484,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 +58715,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 +58884,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.
@@ -59884,6 +60120,12 @@ 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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -60561,6 +60803,12 @@ 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: PageNumber
           in: query
           description: Gets or sets the page number for paged queries.
@@ -60905,6 +61153,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 +61995,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 +64930,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 +65496,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 +65833,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.
@@ -66049,6 +66324,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 +66762,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.
@@ -78164,6 +78449,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 +78896,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 +79165,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 +79440,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 +80163,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 +80499,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 +80657,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 +80821,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.
@@ -81589,6 +81914,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.
@@ -82055,6 +82385,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.
@@ -82343,6 +82678,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.
@@ -82637,6 +82977,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.
@@ -121401,6 +121746,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.
@@ -130263,6 +130612,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 +134440,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 +134691,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: