reach-api-sdk 1.0.201 → 1.0.203

package/src/index.ts

@@ -42,6 +42,7 @@ export type { Course } from './models/Course';
 export { CourseBookingCutoff } from './models/CourseBookingCutoff';
 export type { CourseCreate } from './models/CourseCreate';
 export type { CourseEmailAttendeesPatch } from './models/CourseEmailAttendeesPatch';
+export type { CourseEmailWaitlistPatch } from './models/CourseEmailWaitlistPatch';
 export type { CoursePage } from './models/CoursePage';
 export type { CoursePatch } from './models/CoursePatch';
 export type { CoursePost } from './models/CoursePost';
@@ -187,6 +188,7 @@ export type { OrderItemReport } from './models/OrderItemReport';
 export type { OrderItemReportPage } from './models/OrderItemReportPage';
 export type { OrderItemReportPatch } from './models/OrderItemReportPatch';
 export type { OrderItemReportPost } from './models/OrderItemReportPost';
+export type { OrderItemReportSummary } from './models/OrderItemReportSummary';
 export { OrderItemStatus } from './models/OrderItemStatus';
 export type { OrderPage } from './models/OrderPage';
 export type { OrderPatch } from './models/OrderPatch';
@@ -270,6 +272,7 @@ export type { RescheduleLogPost } from './models/RescheduleLogPost';
 export type { ResolveSecureAccessTokenRequest } from './models/ResolveSecureAccessTokenRequest';
 export type { ScheduledSession } from './models/ScheduledSession';
 export type { ScheduledSessionEmailAttendeesPatch } from './models/ScheduledSessionEmailAttendeesPatch';
+export type { ScheduledSessionEmailWaitlistPatch } from './models/ScheduledSessionEmailWaitlistPatch';
 export type { ScheduledSessionPage } from './models/ScheduledSessionPage';
 export type { ScheduledSessionPatch } from './models/ScheduledSessionPatch';
 export type { ScheduledSessionPost } from './models/ScheduledSessionPost';
@@ -432,6 +435,10 @@ export type { VenuesReport } from './models/VenuesReport';
 export type { VenuesReportPage } from './models/VenuesReportPage';
 export type { VenuesReportPatch } from './models/VenuesReportPatch';
 export type { VenuesReportPost } from './models/VenuesReportPost';
+export type { VenueType } from './models/VenueType';
+export type { VenueTypePage } from './models/VenueTypePage';
+export type { VenueTypePatch } from './models/VenueTypePatch';
+export type { VenueTypePost } from './models/VenueTypePost';
 export type { WaitlistActivity } from './models/WaitlistActivity';
 export type { WaitlistActivityPage } from './models/WaitlistActivityPage';
 export type { WaitlistActivityPatch } from './models/WaitlistActivityPatch';
@@ -527,6 +534,7 @@ export { PublicSurveyQuestionsService } from './services/PublicSurveyQuestionsSe
 export { PublicSurveysService } from './services/PublicSurveysService';
 export { PublicTenantsService } from './services/PublicTenantsService';
 export { PublicVenuesService } from './services/PublicVenuesService';
+export { PublicVenueTypesService } from './services/PublicVenueTypesService';
 export { PublicWaitlistActivityService } from './services/PublicWaitlistActivityService';
 export { PublicWaitlistOpportunityService } from './services/PublicWaitlistOpportunityService';
 export { RecentOrderActivityReportService } from './services/RecentOrderActivityReportService';
@@ -563,6 +571,7 @@ export { VenueManagersService } from './services/VenueManagersService';
 export { VenuePerformanceService } from './services/VenuePerformanceService';
 export { VenuesService } from './services/VenuesService';
 export { VenuesReportService } from './services/VenuesReportService';
+export { VenueTypeService } from './services/VenueTypeService';
 export { WaitlistActivityService } from './services/WaitlistActivityService';
 export { WaitlistActivityReportService } from './services/WaitlistActivityReportService';
 export { WaitlistOpportunityService } from './services/WaitlistOpportunityService';

package/src/models/CourseEmailWaitlistPatch.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for email course waitlist.
+ */
+export type CourseEmailWaitlistPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  /**
+   * Gets or sets the message body.
+   */
+  message?: string | null;
+};

package/src/models/CreateOffer.ts

@@ -15,4 +15,20 @@ export type CreateOffer = {
    * Gets or sets the offer total/gross price.
    */
   priceTotal: number;
+  /**
+   * Gets or sets the maximum number of this offer that can be sold per opportunity.
+   */
+  maxAvailablePerOpportunity?: number | null;
+  /**
+   * Gets or sets when this offer becomes available for booking.
+   */
+  availableFrom?: string | null;
+  /**
+   * Gets or sets when this offer stops being available for booking.
+   */
+  availableUntil?: string | null;
+  /**
+   * Gets or sets the offer description.
+   */
+  description?: string | null;
 };

package/src/models/GenericActivity.ts

@@ -68,6 +68,18 @@ export type GenericActivity = {
    * Gets or sets the description.
    */
   description?: string | null;
+  /**
+   * Gets or sets a description of the schedule.
+   */
+  scheduleDescription?: string | null;
+  /**
+   * Gets or sets a summary of the schedule.
+   */
+  scheduleSummary?: string | null;
+  /**
+   * Gets or sets a value indicating whether the session has a schedule summary.
+   */
+  hasScheduleSummary?: boolean | null;
   /**
    * Gets or sets the image url.
    */

package/src/models/Offer.ts

@@ -91,6 +91,31 @@ export type Offer = {
    * Gets or sets a value indicating whether the offer is private (available to relevant authenticated users and NOT visible to the public).
    */
   active: boolean;
+  /**
+   * Gets or sets the maximum number of this offer that can be sold per opportunity.
+   */
+  maxAvailablePerOpportunity?: number | null;
+  /**
+   * Gets or sets when this offer becomes available for booking.
+   */
+  availableFrom?: string | null;
+  /**
+   * Gets or sets when this offer stops being available for booking.
+   */
+  availableUntil?: string | null;
+  /**
+   * Gets or sets the offer description.
+   */
+  description?: string | null;
+  /**
+   * Gets a value indicating whether the offer is currently available based on AvailableFrom and AvailableUntil dates.
+   */
+  readonly isAvailable?: boolean;
+  /**
+   * Gets or sets the total number of spots available for this offer based on MaxAvailablePerOpportunity and existing bookings.
+   * This property is calculated by the processors when loading offers.
+   */
+  totalAvailable?: number;
   /**
    * Gets or sets the offers label.
    */

package/src/models/OfferPost.ts

@@ -39,4 +39,20 @@ export type OfferPost = {
    * Gets or sets a value indicating whether the offer is private (available to relevant authenticated users and NOT visible to the public).
    */
   active?: boolean | null;
+  /**
+   * Gets or sets the maximum number of this offer that can be sold per opportunity.
+   */
+  maxAvailablePerOpportunity?: number | null;
+  /**
+   * Gets or sets when this offer becomes available for booking.
+   */
+  availableFrom?: string | null;
+  /**
+   * Gets or sets when this offer stops being available for booking.
+   */
+  availableUntil?: string | null;
+  /**
+   * Gets or sets the offer description.
+   */
+  description?: string | null;
 };

package/src/models/OrderItemReportSummary.ts

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents the order item report summary model.
+ */
+export type OrderItemReportSummary = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive: boolean;
+  /**
+   * Gets or sets the total revenue generated from order items.
+   */
+  revenueGenerated?: number;
+};

package/src/models/Permission.ts

@@ -95,4 +95,8 @@ export type Permission = {
    * Gets or sets a value indicating whether a venue manager has send emails permissions.
    */
   venueManagerSendEmails?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has manage opportunity permissions.
+   */
+  venueManagerManageOpportunity?: boolean;
 };

package/src/models/PermissionPatch.ts

@@ -79,4 +79,8 @@ export type PermissionPatch = {
    * Gets or sets a value indicating whether a venue manager has send emails permissions.
    */
   venueManagerSendEmails?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has manage opportunity permissions.
+   */
+  venueManagerManageOpportunity?: boolean;
 };

package/src/models/ScheduledSessionEmailWaitlistPatch.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for emailing scheduled session waitlist.
+ */
+export type ScheduledSessionEmailWaitlistPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  /**
+   * Gets or sets the message body.
+   */
+  message?: string | null;
+};

package/src/models/Session.ts

@@ -203,6 +203,18 @@ export type Session = {
   deals?: Array<Deal> | null;
   activityType?: ActivityType;
   sessionType?: SessionType;
+  /**
+   * Gets or sets a description of the schedule.
+   */
+  scheduleDescription?: string | null;
+  /**
+   * Gets or sets a summary of the schedule.
+   */
+  scheduleSummary?: string | null;
+  /**
+   * Gets or sets a value indicating whether the session has a schedule summary.
+   */
+  hasScheduleSummary?: boolean | null;
   /**
    * Gets or sets the openactive activity Id.
    */

package/src/models/TemplateOffer.ts

@@ -59,4 +59,20 @@ export type TemplateOffer = {
    * Gets or sets a value indicating whether the offer is active.
    */
   active?: boolean;
+  /**
+   * Gets or sets the maximum number of this offer that can be sold per opportunity.
+   */
+  maxAvailablePerOpportunity?: number | null;
+  /**
+   * Gets or sets when this offer becomes available for booking.
+   */
+  availableFrom?: string | null;
+  /**
+   * Gets or sets when this offer stops being available for booking.
+   */
+  availableUntil?: string | null;
+  /**
+   * Gets or sets the offer description.
+   */
+  description?: string | null;
 };

package/src/models/UpdateOffer.ts

@@ -19,4 +19,20 @@ export type UpdateOffer = {
    * Gets or sets the offer total/gross price.
    */
   priceTotal: number;
+  /**
+   * Gets or sets the maximum number of this offer that can be sold per opportunity.
+   */
+  maxAvailablePerOpportunity?: number | null;
+  /**
+   * Gets or sets when this offer becomes available for booking.
+   */
+  availableFrom?: string | null;
+  /**
+   * Gets or sets when this offer stops being available for booking.
+   */
+  availableUntil?: string | null;
+  /**
+   * Gets or sets the offer description.
+   */
+  description?: string | null;
 };

package/src/models/UserPermission.ts

@@ -99,4 +99,8 @@ export type UserPermission = {
    * Gets or sets a value indicating whether a venue manager has send emails permissions.
    */
   sendEmails?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has manage opportunity permissions.
+   */
+  manageOpportunity?: boolean;
 };

package/src/models/UserPermissionPatch.ts

@@ -79,4 +79,8 @@ export type UserPermissionPatch = {
    * Gets or sets a value indicating whether a venue manager has send emails permissions.
    */
   sendEmails?: boolean;
+  /**
+   * Gets or sets a value indicating whether a venue manager has manage opportunity permissions.
+   */
+  manageOpportunity?: boolean;
 };

package/src/models/Venue.ts

@@ -76,6 +76,10 @@ export type Venue = {
    * Gets a formatted label representation for the activity types available at the venue.
    */
   readonly activityTypesAvailableFormatted?: string | null;
+  /**
+   * Gets or sets the venue type id.
+   */
+  venueTypeId?: string | null;
   /**
    * Gets or sets the user that the venue is assigned to.
    */

package/src/models/VenueType.ts

@@ -0,0 +1,42 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents a Venues type within the Reach application.
+ */
+export type VenueType = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive: boolean;
+  /**
+   * Gets or sets the venue types name.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets the venues types description.
+   */
+  description?: string | null;
+};

package/src/models/VenueTypePage.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Pagination } from './Pagination';
+import type { VenueType } from './VenueType';
+
+export type VenueTypePage = {
+  pagination: Pagination;
+  readonly items: Array<VenueType>;
+};

package/src/models/VenueTypePatch.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for venue type updates.
+ */
+export type VenueTypePatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  /**
+   * Gets or sets the venue types name.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets the venues types description.
+   */
+  description?: string | null;
+};

package/src/models/VenueTypePost.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for venue type inserts.
+ */
+export type VenueTypePost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the venue types name.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets the venues types description.
+   */
+  description?: string | null;
+};

package/src/services/CoursesService.ts

@@ -6,6 +6,7 @@ import type { BookingStatus } from '../models/BookingStatus';
 import type { Course } from '../models/Course';
 import type { CourseCreate } from '../models/CourseCreate';
 import type { CourseEmailAttendeesPatch } from '../models/CourseEmailAttendeesPatch';
+import type { CourseEmailWaitlistPatch } from '../models/CourseEmailWaitlistPatch';
 import type { CoursePage } from '../models/CoursePage';
 import type { CoursePatch } from '../models/CoursePatch';
 import type { CoursePost } from '../models/CoursePost';
@@ -210,6 +211,40 @@ export class CoursesService {
     });
   }
 
+  /**
+   * Emails all on waitlist for the opportunity />.
+   * @returns ScheduledSession OK
+   * @throws ApiError
+   */
+  public contactWaitlist({
+    courseId,
+    requestBody,
+  }: {
+    /**
+     * The course Id.
+     */
+    courseId: string;
+    /**
+     * The patch model.
+     */
+    requestBody?: CourseEmailWaitlistPatch;
+  }): CancelablePromise<ScheduledSession> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/courses/{courseId}/email-waitlist',
+      path: {
+        courseId: courseId,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
   /**
    * Sends the post course completion email />.
    * @returns any OK

package/src/services/GenericActivityService.ts

@@ -171,6 +171,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    venueTypeIds,
     programmeIds,
     pageNumber,
     take,
@@ -316,6 +317,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets a list of venue type ids.
+     */
+    venueTypeIds?: Array<string>;
     /**
      * Gets or sets the Programme ids.
      */
@@ -402,6 +407,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        VenueTypeIds: venueTypeIds,
         ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
@@ -489,6 +495,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    venueTypeIds,
     programmeIds,
     pageNumber,
     take,
@@ -634,6 +641,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets a list of venue type ids.
+     */
+    venueTypeIds?: Array<string>;
     /**
      * Gets or sets the Programme ids.
      */
@@ -720,6 +731,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        VenueTypeIds: venueTypeIds,
         ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
@@ -780,6 +792,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    venueTypeIds,
     programmeIds,
     pageNumber,
     take,
@@ -925,6 +938,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets a list of venue type ids.
+     */
+    venueTypeIds?: Array<string>;
     /**
      * Gets or sets the Programme ids.
      */
@@ -1011,6 +1028,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        VenueTypeIds: venueTypeIds,
         ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
@@ -1071,6 +1089,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    venueTypeIds,
     programmeIds,
     pageNumber,
     take,
@@ -1216,6 +1235,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets a list of venue type ids.
+     */
+    venueTypeIds?: Array<string>;
     /**
      * Gets or sets the Programme ids.
      */
@@ -1302,6 +1325,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        VenueTypeIds: venueTypeIds,
         ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
@@ -1362,6 +1386,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    venueTypeIds,
     programmeIds,
     pageNumber,
     take,
@@ -1507,6 +1532,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets a list of venue type ids.
+     */
+    venueTypeIds?: Array<string>;
     /**
      * Gets or sets the Programme ids.
      */
@@ -1593,6 +1622,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        VenueTypeIds: venueTypeIds,
         ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
@@ -1653,6 +1683,7 @@ export class GenericActivityService {
     periodsOfWeek,
     additionalSupport,
     amenity,
+    venueTypeIds,
     programmeIds,
     pageNumber,
     take,
@@ -1798,6 +1829,10 @@ export class GenericActivityService {
      * Gets or sets AmenityId.
      */
     amenity?: Array<number>;
+    /**
+     * Gets or sets a list of venue type ids.
+     */
+    venueTypeIds?: Array<string>;
     /**
      * Gets or sets the Programme ids.
      */
@@ -1884,6 +1919,7 @@ export class GenericActivityService {
         PeriodsOfWeek: periodsOfWeek,
         AdditionalSupport: additionalSupport,
         Amenity: amenity,
+        VenueTypeIds: venueTypeIds,
         ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,