reach-api-sdk 1.0.97 → 1.0.98

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -74,7 +74,7 @@ type Surface = {
74
74
  };
75
75
 
76
76
  /**
77
- * Represents a Country within the Reach application.
77
+ * Represents an activity category within the Reach application.
78
78
  */
79
79
  type Activity = {
80
80
  /**
@@ -4092,6 +4092,7 @@ type OrderItem = {
4092
4092
  offer?: Offer;
4093
4093
  opportunityType?: OpportunityType;
4094
4094
  opportunity?: IOpportunity;
4095
+ cancellable?: CustomerCancellationOption;
4095
4096
  };
4096
4097
 
4097
4098
  /**
@@ -4386,6 +4387,10 @@ type Order = {
4386
4387
  * Gets or sets a value indicating whether the payment require notifications to be sent.
4387
4388
  */
4388
4389
  requiresPaymentNotification: boolean;
4390
+ /**
4391
+ * Gets or sets the checkout url.
4392
+ */
4393
+ checkoutUrl?: string | null;
4389
4394
  /**
4390
4395
  * Gets or sets the orders stripe payment intent client secret.
4391
4396
  */
@@ -5570,6 +5575,24 @@ type CourseCreate = {
5570
5575
  emailSettings?: CreateEmailSettings;
5571
5576
  };
5572
5577
 
5578
+ /**
5579
+ * Post model for email course attendees.
5580
+ */
5581
+ type CourseEmailAttendeesPatch = {
5582
+ /**
5583
+ * Gets or sets the tenant Id.
5584
+ */
5585
+ tenantId: string;
5586
+ /**
5587
+ * Gets or sets the Id.
5588
+ */
5589
+ id: string;
5590
+ /**
5591
+ * Gets or sets the message body.
5592
+ */
5593
+ message?: string | null;
5594
+ };
5595
+
5573
5596
  type CoursePage = {
5574
5597
  pagination: Pagination;
5575
5598
  readonly items: Array<Course>;
@@ -5795,6 +5818,21 @@ declare class CoursesService {
5795
5818
  * @throws ApiError
5796
5819
  */
5797
5820
  generateId(): CancelablePromise<string>;
5821
+ /**
5822
+ * Emails all attendees booked onto the opportunity />.
5823
+ * @returns ScheduledSession Success
5824
+ * @throws ApiError
5825
+ */
5826
+ contactAttendees({ courseId, requestBody, }: {
5827
+ /**
5828
+ * The course Id.
5829
+ */
5830
+ courseId: string;
5831
+ /**
5832
+ * The patch model.
5833
+ */
5834
+ requestBody?: CourseEmailAttendeesPatch;
5835
+ }): CancelablePromise<ScheduledSession>;
5798
5836
  /**
5799
5837
  * Sends the post course completion email />.
5800
5838
  * @returns any Success
@@ -9917,6 +9955,7 @@ type GenericActivity = {
9917
9955
  */
9918
9956
  endDateTime?: string | null;
9919
9957
  nextAvailableOpportunity?: IOpportunity;
9958
+ tenant?: Tenant;
9920
9959
  venue?: Venue;
9921
9960
  activity?: Activity;
9922
9961
  programme?: Programme;
@@ -10825,6 +10864,10 @@ type PlaceGeometry = {
10825
10864
  */
10826
10865
  type PlaceResult = {
10827
10866
  geometry?: PlaceGeometry;
10867
+ /**
10868
+ * Gets or sets the name.
10869
+ */
10870
+ name?: string | null;
10828
10871
  place_address?: PlaceAddress;
10829
10872
  /**
10830
10873
  * Gets or sets the address components.
@@ -14674,6 +14717,14 @@ declare class OpenactiveFeedItemService {
14674
14717
  }): CancelablePromise<boolean>;
14675
14718
  }
14676
14719
 
14720
+ /**
14721
+ * The opportunity status.
14722
+ */
14723
+ declare enum OpportunityRegisterStatus {
14724
+ ACTIVE = "Active",
14725
+ CANCELLED = "Cancelled"
14726
+ }
14727
+
14677
14728
  /**
14678
14729
  * Represents an opportunity registration within the Reach application.
14679
14730
  */
@@ -14734,6 +14785,7 @@ type OpportunityRegister = {
14734
14785
  * Gets or sets the opportunity id that the attendee was moved from.
14735
14786
  */
14736
14787
  movedFrom?: string | null;
14788
+ status?: OpportunityRegisterStatus;
14737
14789
  attendee?: Attendee;
14738
14790
  orderItem?: OrderItem;
14739
14791
  scheduledSession?: ScheduledSession;
@@ -20025,6 +20077,25 @@ declare class PublicOrdersService {
20025
20077
  */
20026
20078
  xTenantSubdomain?: string;
20027
20079
  }): CancelablePromise<any>;
20080
+ /**
20081
+ * Cancels the order and requests a refund.
20082
+ * @returns any Success
20083
+ * @throws ApiError
20084
+ */
20085
+ cancelWithRefund({ id, xTenantSubdomain, requestBody, }: {
20086
+ /**
20087
+ * The order id.
20088
+ */
20089
+ id: string;
20090
+ /**
20091
+ * The tenants subdomain.
20092
+ */
20093
+ xTenantSubdomain?: string;
20094
+ /**
20095
+ * The order items in the case of a partial refund.
20096
+ */
20097
+ requestBody?: Array<string>;
20098
+ }): CancelablePromise<any>;
20028
20099
  /**
20029
20100
  * Returns a value indicating whether the resource exists in the database given the provided search params.
20030
20101
  * @returns boolean Success
@@ -23741,18 +23812,29 @@ declare class PublicTenantsService {
23741
23812
  * @returns Tenant Success
23742
23813
  * @throws ApiError
23743
23814
  */
23744
- getObject({ xTenantSubdomain, }: {
23815
+ init({ xTenantSubdomain, }: {
23745
23816
  /**
23746
23817
  * The tenants subdomain.
23747
23818
  */
23748
23819
  xTenantSubdomain?: string;
23749
23820
  }): CancelablePromise<Tenant>;
23821
+ /**
23822
+ * Gets a Reach.Models.Tenant by its subdomain.
23823
+ * @returns Tenant Success
23824
+ * @throws ApiError
23825
+ */
23826
+ initById({ id, }: {
23827
+ /**
23828
+ * The tenants id.
23829
+ */
23830
+ id: string;
23831
+ }): CancelablePromise<Tenant>;
23750
23832
  /**
23751
23833
  * Gets the resource by its Id.
23752
23834
  * @returns Tenant Success
23753
23835
  * @throws ApiError
23754
23836
  */
23755
- getObject1({ id, xTenantSubdomain, }: {
23837
+ getObject({ id, xTenantSubdomain, }: {
23756
23838
  /**
23757
23839
  * The <typeparamref name="TObject" /> id.
23758
23840
  */
@@ -25828,7 +25910,7 @@ declare class RescheduleLogService {
25828
25910
  }
25829
25911
 
25830
25912
  /**
25831
- * Post model for scheduled session rescheduling updates.
25913
+ * Post model for emailing scheduled session attendees.
25832
25914
  */
25833
25915
  type ScheduledSessionEmailAttendeesPatch = {
25834
25916
  /**
@@ -38375,4 +38457,4 @@ type ValidationResultModel = {
38375
38457
  readonly errors?: Array<ValidationError> | null;
38376
38458
  };
38377
38459
 
38378
- export { Activity, ActivityService, ActivityType, AddressComponent, AdvanceBooking, Amenity, AmenityService, ApiClient, ApiError, AppUserRole, ApplicationRole, Attendee, AttendeePage, AttendeePatch, AttendeePost, AttendeesService, AutoCompleteResponseModel, BadEnglandReportService, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, ChatService, ChoiceMessage, CompletionChoice, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CourseCreate, CoursePage, CoursePatch, CoursePost, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionPatch, CourseSessionPost, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulePatch, CourseSessionSchedulePost, CourseSessionSchedulesService, CourseSessionsService, CourseStatus, CoursesService, CreateEmailSettings, CreateOffer, CreateQuestion, CreateQuestionOption, CreateTemplateDetail, CreateVenue, Customer, CustomerCancellationOption, CustomerEmailPatch, CustomerPage, CustomerPatch, CustomerPost, CustomerStats, CustomerType, CustomersService, DatabaseState, DayOfWeek, DescriptionCompletionResponse, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulePatch, EmailReminderSchedulePost, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingPatch, EmailSettingPost, EmailSettingsService, EnglandGolfReportService, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualPatch, FacilityIndividualPost, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, FacilityPatch, FacilityPost, FilestackImageMetaResponseModel, FilestackService, Gender, GenericActivity, GenericActivityPage, GenericActivityPatch, GenericActivityPost, GenericActivityService, GeocodeResponseModel, GeocodeService, GooglePrediction, HereAddressDetails, HereAutoComplete, HereAutocompleteLookupService, HereLookupResults, HereMapDetails, HerePositionDetails, HttpStatusCode, IOpportunity, Image, ImagePage, ImagePatch, ImagePost, ImagesService, InviteStatus, LeasingService, LoqateGeocode, LoqatePlaceResult, LoqatePlacesService, LoqatePrediction, Northeast, NotificationQueue, NotificationQueuePage, NotificationQueuePatch, NotificationQueuePost, NotificationQueueService, NotificationSetting, NotificationSettingPage, NotificationSettingPatch, NotificationSettingPost, NotificationSettingsService, NotificationType, Offer, OfferPage, OfferPatch, OfferPost, OffersService, OpenAPI, OpenAPIConfig, OpenactiveFeedIntermediate, OpenactiveFeedIntermediatePage, OpenactiveFeedIntermediatePatch, OpenactiveFeedIntermediatePost, OpenactiveFeedIntermediateService, OpenactiveFeedItem, OpenactiveFeedItemPage, OpenactiveFeedItemPatch, OpenactiveFeedItemPost, OpenactiveFeedItemService, OpportunityRegister, OpportunityRegisterPage, OpportunityRegisterPatch, OpportunityRegisterPost, OpportunityRegisterService, OpportunityType, Order, OrderEmailCustomerPatch, OrderItem, OrderItemPage, OrderItemPatch, OrderItemPost, OrderItemStatus, OrderItemsService, OrderPage, OrderPatch, OrderPatchItem, OrderPost, OrderPostItem, OrderRefresh, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrderTokenPatch, OrderTokenPost, OrderUpdateContact, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationPatch, OrgCourseUtilisationPost, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, Pagination, Payment, PaymentMethod, PaymentPage, PaymentPatch, PaymentPost, PaymentsService, PeriodsOfWeek, Permission, PermissionPage, PermissionPatch, PermissionPost, PermissionsService, PlaceAddress, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammePatch, ProgrammePost, ProgrammesService, PublicBookingService, PublicCoursesService, PublicCustomersService, PublicFacilitiesService, PublicGenericActivityService, PublicHealthCheckService, PublicLeasingService, PublicNetworksService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicScheduledSessionsService, PublicSessionsService, PublicSlotsService, PublicStripeWebhookService, PublicSurveyCompletionLogsService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantsService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, QuestionIndex, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportPatch, RecentOrderActivityReportPost, RecentOrderActivityReportService, RefundStatus, RescheduleLog, RescheduleLogPage, RescheduleLogPatch, RescheduleLogPost, RescheduleLogService, ScheduleStatus, ScheduledSession, ScheduledSessionEmailAttendeesPatch, ScheduledSessionPage, ScheduledSessionPatch, ScheduledSessionPost, ScheduledSessionReschedulePatch, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSchedulePatch, ScheduledSessionSchedulePost, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, Session, SessionCreate, SessionPage, SessionPatch, SessionPost, SessionType, SessionsService, Slot, SlotAvailabilityStatus, SlotOffer, SlotOfferPage, SlotOfferPatch, SlotOfferPost, SlotOffersService, SlotPage, SlotPatch, SlotPost, SlotSchedule, SlotScheduleOffer, SlotScheduleOfferPage, SlotScheduleOfferPatch, SlotScheduleOfferPost, SlotScheduleOffersService, SlotSchedulePage, SlotSchedulePatch, SlotSchedulePost, SlotSchedulesService, SlotStatus, SlotsService, Southwest, StripeAccount, StripeAccountPage, StripeAccountPatch, StripeAccountPost, StripeAccountService, StructuredFormatting, Surface, SurfacesService, Survey, SurveyAnswer, SurveyAnswerPage, SurveyAnswerPatch, SurveyAnswerPost, SurveyAnswersService, SurveyCompletionLog, SurveyCompletionLogPage, SurveyCompletionLogPatch, SurveyCompletionLogPost, SurveyCompletionLogService, SurveyCreate, SurveyPage, SurveyPatch, SurveyPost, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionPatch, SurveyQuestionPatchOption, SurveyQuestionPost, SurveyQuestionPostOption, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveyReportExtended, SurveyReportExtendedPage, SurveyReportExtendedPatch, SurveyReportExtendedPost, SurveyReportExtendedService, SurveyResponseMode, SurveySubmissionModel, SurveySubmit, SurveySubmitAttendee, SurveySubmitQuestions, SurveyType, SurveysService, Tax, Template, TemplateCreate, TemplateDetail, TemplateDetailPage, TemplateDetailPatch, TemplateDetailPost, TemplateDetailsService, TemplateDuplicatePost, TemplateFromPost, TemplateOffer, TemplateOfferPage, TemplateOfferPatch, TemplateOfferPost, TemplateOffersService, TemplatePage, TemplatePatch, TemplatePost, TemplateUseResponse, TemplatesService, Tenant, TenantPage, TenantPatch, TenantPost, TenantTier, TenantWebsiteSetting, TenantWebsiteSettingPage, TenantWebsiteSettingPatch, TenantWebsiteSettingPost, TenantWebsiteSettingsService, TenantsService, Timezone, TimezoneService, TotalRevenueReport, TotalRevenueReportPage, TotalRevenueReportPatch, TotalRevenueReportPost, TotalRevenueReportService, UpdateEmailSettings, UpdateOffer, User, UserPage, UserPatch, UserPost, UserRole, UsersService, ValidationError, ValidationResultModel, Venue, VenueBadmintonEnglandReport, VenueBadmintonEnglandReportPage, VenueBadmintonEnglandReportPatch, VenueBadmintonEnglandReportPost, VenueCreate, VenueManager, VenueManagerPage, VenueManagerPatch, VenueManagerPost, VenueManagersService, VenueOpeningHourUpdate, VenueOpeningHours, VenuePage, VenuePatch, VenuePost, VenuesReport, VenuesReportPage, VenuesReportPatch, VenuesReportPost, VenuesReportService, VenuesService, WaitlistActivity, WaitlistActivityPage, WaitlistActivityPatch, WaitlistActivityPost, WaitlistActivityService, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityPatch, WaitlistOpportunityPost, WaitlistOpportunityService };
38460
+ export { Activity, ActivityService, ActivityType, AddressComponent, AdvanceBooking, Amenity, AmenityService, ApiClient, ApiError, AppUserRole, ApplicationRole, Attendee, AttendeePage, AttendeePatch, AttendeePost, AttendeesService, AutoCompleteResponseModel, BadEnglandReportService, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, ChatService, ChoiceMessage, CompletionChoice, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CourseCreate, CourseEmailAttendeesPatch, CoursePage, CoursePatch, CoursePost, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionPatch, CourseSessionPost, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulePatch, CourseSessionSchedulePost, CourseSessionSchedulesService, CourseSessionsService, CourseStatus, CoursesService, CreateEmailSettings, CreateOffer, CreateQuestion, CreateQuestionOption, CreateTemplateDetail, CreateVenue, Customer, CustomerCancellationOption, CustomerEmailPatch, CustomerPage, CustomerPatch, CustomerPost, CustomerStats, CustomerType, CustomersService, DatabaseState, DayOfWeek, DescriptionCompletionResponse, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulePatch, EmailReminderSchedulePost, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingPatch, EmailSettingPost, EmailSettingsService, EnglandGolfReportService, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualPatch, FacilityIndividualPost, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, FacilityPatch, FacilityPost, FilestackImageMetaResponseModel, FilestackService, Gender, GenericActivity, GenericActivityPage, GenericActivityPatch, GenericActivityPost, GenericActivityService, GeocodeResponseModel, GeocodeService, GooglePrediction, HereAddressDetails, HereAutoComplete, HereAutocompleteLookupService, HereLookupResults, HereMapDetails, HerePositionDetails, HttpStatusCode, IOpportunity, Image, ImagePage, ImagePatch, ImagePost, ImagesService, InviteStatus, LeasingService, LoqateGeocode, LoqatePlaceResult, LoqatePlacesService, LoqatePrediction, Northeast, NotificationQueue, NotificationQueuePage, NotificationQueuePatch, NotificationQueuePost, NotificationQueueService, NotificationSetting, NotificationSettingPage, NotificationSettingPatch, NotificationSettingPost, NotificationSettingsService, NotificationType, Offer, OfferPage, OfferPatch, OfferPost, OffersService, OpenAPI, OpenAPIConfig, OpenactiveFeedIntermediate, OpenactiveFeedIntermediatePage, OpenactiveFeedIntermediatePatch, OpenactiveFeedIntermediatePost, OpenactiveFeedIntermediateService, OpenactiveFeedItem, OpenactiveFeedItemPage, OpenactiveFeedItemPatch, OpenactiveFeedItemPost, OpenactiveFeedItemService, OpportunityRegister, OpportunityRegisterPage, OpportunityRegisterPatch, OpportunityRegisterPost, OpportunityRegisterService, OpportunityRegisterStatus, OpportunityType, Order, OrderEmailCustomerPatch, OrderItem, OrderItemPage, OrderItemPatch, OrderItemPost, OrderItemStatus, OrderItemsService, OrderPage, OrderPatch, OrderPatchItem, OrderPost, OrderPostItem, OrderRefresh, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrderTokenPatch, OrderTokenPost, OrderUpdateContact, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationPatch, OrgCourseUtilisationPost, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, Pagination, Payment, PaymentMethod, PaymentPage, PaymentPatch, PaymentPost, PaymentsService, PeriodsOfWeek, Permission, PermissionPage, PermissionPatch, PermissionPost, PermissionsService, PlaceAddress, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammePatch, ProgrammePost, ProgrammesService, PublicBookingService, PublicCoursesService, PublicCustomersService, PublicFacilitiesService, PublicGenericActivityService, PublicHealthCheckService, PublicLeasingService, PublicNetworksService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicScheduledSessionsService, PublicSessionsService, PublicSlotsService, PublicStripeWebhookService, PublicSurveyCompletionLogsService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantsService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, QuestionIndex, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportPatch, RecentOrderActivityReportPost, RecentOrderActivityReportService, RefundStatus, RescheduleLog, RescheduleLogPage, RescheduleLogPatch, RescheduleLogPost, RescheduleLogService, ScheduleStatus, ScheduledSession, ScheduledSessionEmailAttendeesPatch, ScheduledSessionPage, ScheduledSessionPatch, ScheduledSessionPost, ScheduledSessionReschedulePatch, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSchedulePatch, ScheduledSessionSchedulePost, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, Session, SessionCreate, SessionPage, SessionPatch, SessionPost, SessionType, SessionsService, Slot, SlotAvailabilityStatus, SlotOffer, SlotOfferPage, SlotOfferPatch, SlotOfferPost, SlotOffersService, SlotPage, SlotPatch, SlotPost, SlotSchedule, SlotScheduleOffer, SlotScheduleOfferPage, SlotScheduleOfferPatch, SlotScheduleOfferPost, SlotScheduleOffersService, SlotSchedulePage, SlotSchedulePatch, SlotSchedulePost, SlotSchedulesService, SlotStatus, SlotsService, Southwest, StripeAccount, StripeAccountPage, StripeAccountPatch, StripeAccountPost, StripeAccountService, StructuredFormatting, Surface, SurfacesService, Survey, SurveyAnswer, SurveyAnswerPage, SurveyAnswerPatch, SurveyAnswerPost, SurveyAnswersService, SurveyCompletionLog, SurveyCompletionLogPage, SurveyCompletionLogPatch, SurveyCompletionLogPost, SurveyCompletionLogService, SurveyCreate, SurveyPage, SurveyPatch, SurveyPost, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionPatch, SurveyQuestionPatchOption, SurveyQuestionPost, SurveyQuestionPostOption, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveyReportExtended, SurveyReportExtendedPage, SurveyReportExtendedPatch, SurveyReportExtendedPost, SurveyReportExtendedService, SurveyResponseMode, SurveySubmissionModel, SurveySubmit, SurveySubmitAttendee, SurveySubmitQuestions, SurveyType, SurveysService, Tax, Template, TemplateCreate, TemplateDetail, TemplateDetailPage, TemplateDetailPatch, TemplateDetailPost, TemplateDetailsService, TemplateDuplicatePost, TemplateFromPost, TemplateOffer, TemplateOfferPage, TemplateOfferPatch, TemplateOfferPost, TemplateOffersService, TemplatePage, TemplatePatch, TemplatePost, TemplateUseResponse, TemplatesService, Tenant, TenantPage, TenantPatch, TenantPost, TenantTier, TenantWebsiteSetting, TenantWebsiteSettingPage, TenantWebsiteSettingPatch, TenantWebsiteSettingPost, TenantWebsiteSettingsService, TenantsService, Timezone, TimezoneService, TotalRevenueReport, TotalRevenueReportPage, TotalRevenueReportPatch, TotalRevenueReportPost, TotalRevenueReportService, UpdateEmailSettings, UpdateOffer, User, UserPage, UserPatch, UserPost, UserRole, UsersService, ValidationError, ValidationResultModel, Venue, VenueBadmintonEnglandReport, VenueBadmintonEnglandReportPage, VenueBadmintonEnglandReportPatch, VenueBadmintonEnglandReportPost, VenueCreate, VenueManager, VenueManagerPage, VenueManagerPatch, VenueManagerPost, VenueManagersService, VenueOpeningHourUpdate, VenueOpeningHours, VenuePage, VenuePatch, VenuePost, VenuesReport, VenuesReportPage, VenuesReportPatch, VenuesReportPost, VenuesReportService, VenuesService, WaitlistActivity, WaitlistActivityPage, WaitlistActivityPatch, WaitlistActivityPost, WaitlistActivityService, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityPatch, WaitlistOpportunityPost, WaitlistOpportunityService };
package/dist/reach-sdk.js CHANGED
@@ -2059,6 +2059,30 @@ const request = (config, options, axiosClient = axios) => {
2059
2059
  }
2060
2060
  });
2061
2061
  }
2062
+ /**
2063
+ * Emails all attendees booked onto the opportunity />.
2064
+ * @returns ScheduledSession Success
2065
+ * @throws ApiError
2066
+ */
2067
+ contactAttendees({
2068
+ courseId,
2069
+ requestBody
2070
+ }) {
2071
+ return this.httpRequest.request({
2072
+ method: "PATCH",
2073
+ url: "/api/courses/{courseId}/email-attendees",
2074
+ path: {
2075
+ courseId
2076
+ },
2077
+ body: requestBody,
2078
+ mediaType: "application/json",
2079
+ errors: {
2080
+ 400: `Bad Request`,
2081
+ 422: `Client Error`,
2082
+ 500: `Server Error`
2083
+ }
2084
+ });
2085
+ }
2062
2086
  /**
2063
2087
  * Sends the post course completion email />.
2064
2088
  * @returns any Success
@@ -13810,6 +13834,34 @@ const request = (config, options, axiosClient = axios) => {
13810
13834
  }
13811
13835
  });
13812
13836
  }
13837
+ /**
13838
+ * Cancels the order and requests a refund.
13839
+ * @returns any Success
13840
+ * @throws ApiError
13841
+ */
13842
+ cancelWithRefund({
13843
+ id,
13844
+ xTenantSubdomain,
13845
+ requestBody
13846
+ }) {
13847
+ return this.httpRequest.request({
13848
+ method: "POST",
13849
+ url: "/api/public/orders/{id}/cancel-with-refund",
13850
+ path: {
13851
+ id
13852
+ },
13853
+ headers: {
13854
+ x_tenant_subdomain: xTenantSubdomain
13855
+ },
13856
+ body: requestBody,
13857
+ mediaType: "application/json",
13858
+ errors: {
13859
+ 400: `Bad Request`,
13860
+ 422: `Client Error`,
13861
+ 500: `Server Error`
13862
+ }
13863
+ });
13864
+ }
13813
13865
  /**
13814
13866
  * Returns a value indicating whether the resource exists in the database given the provided search params.
13815
13867
  * @returns boolean Success
@@ -16563,7 +16615,7 @@ const request = (config, options, axiosClient = axios) => {
16563
16615
  * @returns Tenant Success
16564
16616
  * @throws ApiError
16565
16617
  */
16566
- getObject({
16618
+ init({
16567
16619
  xTenantSubdomain
16568
16620
  }) {
16569
16621
  return this.httpRequest.request({
@@ -16579,12 +16631,33 @@ const request = (config, options, axiosClient = axios) => {
16579
16631
  }
16580
16632
  });
16581
16633
  }
16634
+ /**
16635
+ * Gets a Reach.Models.Tenant by its subdomain.
16636
+ * @returns Tenant Success
16637
+ * @throws ApiError
16638
+ */
16639
+ initById({
16640
+ id
16641
+ }) {
16642
+ return this.httpRequest.request({
16643
+ method: "GET",
16644
+ url: "/api/public/tenants/init/{id}",
16645
+ path: {
16646
+ id
16647
+ },
16648
+ errors: {
16649
+ 400: `Bad Request`,
16650
+ 422: `Client Error`,
16651
+ 500: `Server Error`
16652
+ }
16653
+ });
16654
+ }
16582
16655
  /**
16583
16656
  * Gets the resource by its Id.
16584
16657
  * @returns Tenant Success
16585
16658
  * @throws ApiError
16586
16659
  */
16587
- getObject1({
16660
+ getObject({
16588
16661
  id,
16589
16662
  xTenantSubdomain
16590
16663
  }) {
@@ -29481,7 +29554,11 @@ const request = (config, options, axiosClient = axios) => {
29481
29554
  NotificationType2["PAYMENT_RECIEVED"] = "PaymentRecieved";
29482
29555
  NotificationType2["POST_COMPLETION_SURVEY_COMPLETED"] = "PostCompletionSurveyCompleted";
29483
29556
  return NotificationType2;
29484
- })(NotificationType || {});var OpportunityType = /* @__PURE__ */ ((OpportunityType2) => {
29557
+ })(NotificationType || {});var OpportunityRegisterStatus = /* @__PURE__ */ ((OpportunityRegisterStatus2) => {
29558
+ OpportunityRegisterStatus2["ACTIVE"] = "Active";
29559
+ OpportunityRegisterStatus2["CANCELLED"] = "Cancelled";
29560
+ return OpportunityRegisterStatus2;
29561
+ })(OpportunityRegisterStatus || {});var OpportunityType = /* @__PURE__ */ ((OpportunityType2) => {
29485
29562
  OpportunityType2["SLOT"] = "Slot";
29486
29563
  OpportunityType2["SCHEDULED_SESSION"] = "ScheduledSession";
29487
29564
  OpportunityType2["COURSE"] = "Course";
@@ -29622,4 +29699,4 @@ const request = (config, options, axiosClient = axios) => {
29622
29699
  TenantTier2["ENTERPRISE"] = "Enterprise";
29623
29700
  TenantTier2["PRO"] = "Pro";
29624
29701
  return TenantTier2;
29625
- })(TenantTier || {});export{ActivityService,ActivityType,AdvanceBooking,AmenityService,ApiClient,ApiError,AppUserRole,ApplicationRole,AttendeesService,BadEnglandReportService,BaseHttpRequest,BookingService,BookingStatus,CancelError,CancelablePromise,ChatService,ContactOnConfirmation,CountryService,CourseBookingCutoff,CourseSearchSortBy,CourseSessionSchedulesService,CourseSessionsService,CourseStatus,CoursesService,CustomerCancellationOption,CustomerType,CustomersService,DayOfWeek,EmailReminderSchedulesService,EmailSettingsService,EnglandGolfReportService,FacilitiesService,FacilityIndividualsService,FacilityIndividualsType,FilestackService,Gender,GenericActivityService,GeocodeService,HereAutocompleteLookupService,HttpStatusCode,ImagesService,InviteStatus,LeasingService,LoqatePlacesService,NotificationQueueService,NotificationSettingsService,NotificationType,OffersService,OpenAPI,OpenactiveFeedIntermediateService,OpenactiveFeedItemService,OpportunityRegisterService,OpportunityType,OrderItemStatus,OrderItemsService,OrderSource,OrderStage,OrdersService,OrgCourseUtilisationService,OrganisationApplicationFeeHandling,OrganisationAvailableChannel,OrganisationRefundPolicy,OrganisationTaxMode,OrganisationType,PaymentMethod,PaymentsService,PeriodsOfWeek,PermissionsService,PlacesService,Prepayment,ProgrammesService,PublicBookingService,PublicCoursesService,PublicCustomersService,PublicFacilitiesService,PublicGenericActivityService,PublicHealthCheckService,PublicLeasingService,PublicNetworksService,PublicOrderTokensService,PublicOrdersService,PublicProgrammesService,PublicScheduledSessionsService,PublicSessionsService,PublicSlotsService,PublicStripeWebhookService,PublicSurveyCompletionLogsService,PublicSurveyQuestionsService,PublicSurveysService,PublicTenantsService,PublicVenuesService,PublicWaitlistActivityService,PublicWaitlistOpportunityService,ReachEntity,ReachOperation,RecentOrderActivityReportService,RefundStatus,RescheduleLogService,ScheduleStatus,ScheduledSessionSearchSortBy,ScheduledSessionsSchedulesService,ScheduledSessionsService,SearchSortOrderDirection,SessionType,SessionsService,SlotAvailabilityStatus,SlotOffersService,SlotScheduleOffersService,SlotSchedulesService,SlotStatus,SlotsService,StripeAccountService,SurfacesService,SurveyAnswersService,SurveyCompletionLogService,SurveyQuestionType,SurveyQuestionsService,SurveyQuestionsTarget,SurveyReportExtendedService,SurveyResponseMode,SurveyType,SurveysService,TemplateDetailsService,TemplateOffersService,TemplatesService,TenantTier,TenantWebsiteSettingsService,TenantsService,TimezoneService,TotalRevenueReportService,UsersService,VenueManagersService,VenuesReportService,VenuesService,WaitlistActivityService,WaitlistOpportunityService};
29702
+ })(TenantTier || {});export{ActivityService,ActivityType,AdvanceBooking,AmenityService,ApiClient,ApiError,AppUserRole,ApplicationRole,AttendeesService,BadEnglandReportService,BaseHttpRequest,BookingService,BookingStatus,CancelError,CancelablePromise,ChatService,ContactOnConfirmation,CountryService,CourseBookingCutoff,CourseSearchSortBy,CourseSessionSchedulesService,CourseSessionsService,CourseStatus,CoursesService,CustomerCancellationOption,CustomerType,CustomersService,DayOfWeek,EmailReminderSchedulesService,EmailSettingsService,EnglandGolfReportService,FacilitiesService,FacilityIndividualsService,FacilityIndividualsType,FilestackService,Gender,GenericActivityService,GeocodeService,HereAutocompleteLookupService,HttpStatusCode,ImagesService,InviteStatus,LeasingService,LoqatePlacesService,NotificationQueueService,NotificationSettingsService,NotificationType,OffersService,OpenAPI,OpenactiveFeedIntermediateService,OpenactiveFeedItemService,OpportunityRegisterService,OpportunityRegisterStatus,OpportunityType,OrderItemStatus,OrderItemsService,OrderSource,OrderStage,OrdersService,OrgCourseUtilisationService,OrganisationApplicationFeeHandling,OrganisationAvailableChannel,OrganisationRefundPolicy,OrganisationTaxMode,OrganisationType,PaymentMethod,PaymentsService,PeriodsOfWeek,PermissionsService,PlacesService,Prepayment,ProgrammesService,PublicBookingService,PublicCoursesService,PublicCustomersService,PublicFacilitiesService,PublicGenericActivityService,PublicHealthCheckService,PublicLeasingService,PublicNetworksService,PublicOrderTokensService,PublicOrdersService,PublicProgrammesService,PublicScheduledSessionsService,PublicSessionsService,PublicSlotsService,PublicStripeWebhookService,PublicSurveyCompletionLogsService,PublicSurveyQuestionsService,PublicSurveysService,PublicTenantsService,PublicVenuesService,PublicWaitlistActivityService,PublicWaitlistOpportunityService,ReachEntity,ReachOperation,RecentOrderActivityReportService,RefundStatus,RescheduleLogService,ScheduleStatus,ScheduledSessionSearchSortBy,ScheduledSessionsSchedulesService,ScheduledSessionsService,SearchSortOrderDirection,SessionType,SessionsService,SlotAvailabilityStatus,SlotOffersService,SlotScheduleOffersService,SlotSchedulesService,SlotStatus,SlotsService,StripeAccountService,SurfacesService,SurveyAnswersService,SurveyCompletionLogService,SurveyQuestionType,SurveyQuestionsService,SurveyQuestionsTarget,SurveyReportExtendedService,SurveyResponseMode,SurveyType,SurveysService,TemplateDetailsService,TemplateOffersService,TemplatesService,TenantTier,TenantWebsiteSettingsService,TenantsService,TimezoneService,TotalRevenueReportService,UsersService,VenueManagersService,VenuesReportService,VenuesService,WaitlistActivityService,WaitlistOpportunityService};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "reach-api-sdk",
3
- "version": "1.0.97",
3
+ "version": "1.0.98",
4
4
  "description": "sdk for reach api",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -5049,6 +5049,81 @@ paths:
5049
5049
  text/json:
5050
5050
  schema:
5051
5051
  $ref: '#/components/schemas/ValidationResultModel'
5052
+ '/api/courses/{courseId}/email-attendees':
5053
+ patch:
5054
+ tags:
5055
+ - Courses
5056
+ summary: Emails all attendees booked onto the opportunity />.
5057
+ operationId: ContactAttendees
5058
+ parameters:
5059
+ - name: courseId
5060
+ in: path
5061
+ description: The course Id.
5062
+ required: true
5063
+ schema:
5064
+ type: string
5065
+ format: uuid
5066
+ requestBody:
5067
+ description: The patch model.
5068
+ content:
5069
+ application/json:
5070
+ schema:
5071
+ $ref: '#/components/schemas/CourseEmailAttendeesPatch'
5072
+ text/json:
5073
+ schema:
5074
+ $ref: '#/components/schemas/CourseEmailAttendeesPatch'
5075
+ application/*+json:
5076
+ schema:
5077
+ $ref: '#/components/schemas/CourseEmailAttendeesPatch'
5078
+ responses:
5079
+ '200':
5080
+ description: Success
5081
+ content:
5082
+ text/plain:
5083
+ schema:
5084
+ $ref: '#/components/schemas/ScheduledSession'
5085
+ application/json:
5086
+ schema:
5087
+ $ref: '#/components/schemas/ScheduledSession'
5088
+ text/json:
5089
+ schema:
5090
+ $ref: '#/components/schemas/ScheduledSession'
5091
+ '400':
5092
+ description: Bad Request
5093
+ content:
5094
+ text/plain:
5095
+ schema:
5096
+ $ref: '#/components/schemas/ReachError'
5097
+ application/json:
5098
+ schema:
5099
+ $ref: '#/components/schemas/ReachError'
5100
+ text/json:
5101
+ schema:
5102
+ $ref: '#/components/schemas/ReachError'
5103
+ '500':
5104
+ description: Server Error
5105
+ content:
5106
+ text/plain:
5107
+ schema:
5108
+ $ref: '#/components/schemas/ReachError'
5109
+ application/json:
5110
+ schema:
5111
+ $ref: '#/components/schemas/ReachError'
5112
+ text/json:
5113
+ schema:
5114
+ $ref: '#/components/schemas/ReachError'
5115
+ '422':
5116
+ description: Client Error
5117
+ content:
5118
+ text/plain:
5119
+ schema:
5120
+ $ref: '#/components/schemas/ValidationResultModel'
5121
+ application/json:
5122
+ schema:
5123
+ $ref: '#/components/schemas/ValidationResultModel'
5124
+ text/json:
5125
+ schema:
5126
+ $ref: '#/components/schemas/ValidationResultModel'
5052
5127
  '/api/courses/{courseId}/send-post-completion-email':
5053
5128
  get:
5054
5129
  tags:
@@ -40033,6 +40108,85 @@ paths:
40033
40108
  text/json:
40034
40109
  schema:
40035
40110
  $ref: '#/components/schemas/ValidationResultModel'
40111
+ '/api/public/orders/{id}/cancel-with-refund':
40112
+ post:
40113
+ tags:
40114
+ - PublicOrders
40115
+ summary: Cancels the order and requests a refund.
40116
+ operationId: CancelWithRefund
40117
+ parameters:
40118
+ - name: x_tenant_subdomain
40119
+ in: header
40120
+ description: The tenants subdomain.
40121
+ schema:
40122
+ type: string
40123
+ - name: id
40124
+ in: path
40125
+ description: The order id.
40126
+ required: true
40127
+ schema:
40128
+ type: string
40129
+ format: uuid
40130
+ requestBody:
40131
+ description: The order items in the case of a partial refund.
40132
+ content:
40133
+ application/json:
40134
+ schema:
40135
+ type: array
40136
+ items:
40137
+ type: string
40138
+ format: uuid
40139
+ text/json:
40140
+ schema:
40141
+ type: array
40142
+ items:
40143
+ type: string
40144
+ format: uuid
40145
+ application/*+json:
40146
+ schema:
40147
+ type: array
40148
+ items:
40149
+ type: string
40150
+ format: uuid
40151
+ responses:
40152
+ '200':
40153
+ description: Success
40154
+ '400':
40155
+ description: Bad Request
40156
+ content:
40157
+ text/plain:
40158
+ schema:
40159
+ $ref: '#/components/schemas/ReachError'
40160
+ application/json:
40161
+ schema:
40162
+ $ref: '#/components/schemas/ReachError'
40163
+ text/json:
40164
+ schema:
40165
+ $ref: '#/components/schemas/ReachError'
40166
+ '500':
40167
+ description: Server Error
40168
+ content:
40169
+ text/plain:
40170
+ schema:
40171
+ $ref: '#/components/schemas/ReachError'
40172
+ application/json:
40173
+ schema:
40174
+ $ref: '#/components/schemas/ReachError'
40175
+ text/json:
40176
+ schema:
40177
+ $ref: '#/components/schemas/ReachError'
40178
+ '422':
40179
+ description: Client Error
40180
+ content:
40181
+ text/plain:
40182
+ schema:
40183
+ $ref: '#/components/schemas/ValidationResultModel'
40184
+ application/json:
40185
+ schema:
40186
+ $ref: '#/components/schemas/ValidationResultModel'
40187
+ text/json:
40188
+ schema:
40189
+ $ref: '#/components/schemas/ValidationResultModel'
40036
40190
  /api/public/orders/exists:
40037
40191
  get:
40038
40192
  tags:
@@ -47701,7 +47855,7 @@ paths:
47701
47855
  tags:
47702
47856
  - PublicTenants
47703
47857
  summary: Gets a Reach.Models.Tenant by its subdomain.
47704
- operationId: GetObject
47858
+ operationId: Init
47705
47859
  parameters:
47706
47860
  - name: x_tenant_subdomain
47707
47861
  in: header
@@ -47757,6 +47911,69 @@ paths:
47757
47911
  text/json:
47758
47912
  schema:
47759
47913
  $ref: '#/components/schemas/ValidationResultModel'
47914
+ '/api/public/tenants/init/{id}':
47915
+ get:
47916
+ tags:
47917
+ - PublicTenants
47918
+ summary: Gets a Reach.Models.Tenant by its subdomain.
47919
+ operationId: InitById
47920
+ parameters:
47921
+ - name: id
47922
+ in: path
47923
+ description: The tenants id.
47924
+ required: true
47925
+ schema:
47926
+ type: string
47927
+ format: uuid
47928
+ responses:
47929
+ '200':
47930
+ description: Success
47931
+ content:
47932
+ text/plain:
47933
+ schema:
47934
+ $ref: '#/components/schemas/Tenant'
47935
+ application/json:
47936
+ schema:
47937
+ $ref: '#/components/schemas/Tenant'
47938
+ text/json:
47939
+ schema:
47940
+ $ref: '#/components/schemas/Tenant'
47941
+ '400':
47942
+ description: Bad Request
47943
+ content:
47944
+ text/plain:
47945
+ schema:
47946
+ $ref: '#/components/schemas/ReachError'
47947
+ application/json:
47948
+ schema:
47949
+ $ref: '#/components/schemas/ReachError'
47950
+ text/json:
47951
+ schema:
47952
+ $ref: '#/components/schemas/ReachError'
47953
+ '500':
47954
+ description: Server Error
47955
+ content:
47956
+ text/plain:
47957
+ schema:
47958
+ $ref: '#/components/schemas/ReachError'
47959
+ application/json:
47960
+ schema:
47961
+ $ref: '#/components/schemas/ReachError'
47962
+ text/json:
47963
+ schema:
47964
+ $ref: '#/components/schemas/ReachError'
47965
+ '422':
47966
+ description: Client Error
47967
+ content:
47968
+ text/plain:
47969
+ schema:
47970
+ $ref: '#/components/schemas/ValidationResultModel'
47971
+ application/json:
47972
+ schema:
47973
+ $ref: '#/components/schemas/ValidationResultModel'
47974
+ text/json:
47975
+ schema:
47976
+ $ref: '#/components/schemas/ValidationResultModel'
47760
47977
  '/api/public/tenants/{id}':
47761
47978
  get:
47762
47979
  tags:
@@ -85660,7 +85877,7 @@ components:
85660
85877
  description: Gets or sets the activities referenced surfaces.
85661
85878
  nullable: true
85662
85879
  additionalProperties: false
85663
- description: Represents a Country within the Reach application.
85880
+ description: Represents an activity category within the Reach application.
85664
85881
  ActivityType:
85665
85882
  enum:
85666
85883
  - Facility
@@ -86408,6 +86625,26 @@ components:
86408
86625
  $ref: '#/components/schemas/CreateEmailSettings'
86409
86626
  additionalProperties: false
86410
86627
  description: Post model for course inserts.
86628
+ CourseEmailAttendeesPatch:
86629
+ required:
86630
+ - id
86631
+ - tenantId
86632
+ type: object
86633
+ properties:
86634
+ tenantId:
86635
+ type: string
86636
+ description: Gets or sets the tenant Id.
86637
+ format: uuid
86638
+ id:
86639
+ type: string
86640
+ description: Gets or sets the Id.
86641
+ format: uuid
86642
+ message:
86643
+ type: string
86644
+ description: Gets or sets the message body.
86645
+ nullable: true
86646
+ additionalProperties: false
86647
+ description: Post model for email course attendees.
86411
86648
  CoursePage:
86412
86649
  required:
86413
86650
  - items
@@ -88250,6 +88487,8 @@ components:
88250
88487
  nullable: true
88251
88488
  nextAvailableOpportunity:
88252
88489
  $ref: '#/components/schemas/IOpportunity'
88490
+ tenant:
88491
+ $ref: '#/components/schemas/Tenant'
88253
88492
  venue:
88254
88493
  $ref: '#/components/schemas/Venue'
88255
88494
  activity:
@@ -89604,6 +89843,8 @@ components:
89604
89843
  description: Gets or sets the opportunity id that the attendee was moved from.
89605
89844
  format: uuid
89606
89845
  nullable: true
89846
+ status:
89847
+ $ref: '#/components/schemas/OpportunityRegisterStatus'
89607
89848
  attendee:
89608
89849
  $ref: '#/components/schemas/Attendee'
89609
89850
  orderItem:
@@ -89659,6 +89900,12 @@ components:
89659
89900
  format: uuid
89660
89901
  additionalProperties: false
89661
89902
  description: Post model for Opportunity Register inserts.
89903
+ OpportunityRegisterStatus:
89904
+ enum:
89905
+ - Active
89906
+ - Cancelled
89907
+ type: string
89908
+ description: The opportunity status.
89662
89909
  OpportunityType:
89663
89910
  enum:
89664
89911
  - Slot
@@ -89892,6 +90139,11 @@ components:
89892
90139
  type: boolean
89893
90140
  description: Gets or sets a value indicating whether the payment require notifications to be sent.
89894
90141
  default: false
90142
+ checkoutUrl:
90143
+ type: string
90144
+ description: Gets or sets the checkout url.
90145
+ format: uri
90146
+ nullable: true
89895
90147
  paymentIntentClientSecret:
89896
90148
  type: string
89897
90149
  description: Gets or sets the orders stripe payment intent client secret.
@@ -90049,6 +90301,8 @@ components:
90049
90301
  $ref: '#/components/schemas/OpportunityType'
90050
90302
  opportunity:
90051
90303
  $ref: '#/components/schemas/IOpportunity'
90304
+ cancellable:
90305
+ $ref: '#/components/schemas/CustomerCancellationOption'
90052
90306
  additionalProperties: false
90053
90307
  description: Represents an Order of a currently available bookable Reach.Models.OrderItem.Slot within the Reach application.
90054
90308
  OrderItemPage:
@@ -91011,6 +91265,10 @@ components:
91011
91265
  properties:
91012
91266
  geometry:
91013
91267
  $ref: '#/components/schemas/PlaceGeometry'
91268
+ name:
91269
+ type: string
91270
+ description: Gets or sets the name.
91271
+ nullable: true
91014
91272
  place_address:
91015
91273
  $ref: '#/components/schemas/PlaceAddress'
91016
91274
  address_components:
@@ -91755,7 +92013,7 @@ components:
91755
92013
  description: Gets or sets the message body.
91756
92014
  nullable: true
91757
92015
  additionalProperties: false
91758
- description: Post model for scheduled session rescheduling updates.
92016
+ description: Post model for emailing scheduled session attendees.
91759
92017
  ScheduledSessionPage:
91760
92018
  required:
91761
92019
  - items
package/src/index.ts CHANGED
@@ -30,6 +30,7 @@ export type { Country } from './models/Country';
30
30
  export type { Course } from './models/Course';
31
31
  export { CourseBookingCutoff } from './models/CourseBookingCutoff';
32
32
  export type { CourseCreate } from './models/CourseCreate';
33
+ export type { CourseEmailAttendeesPatch } from './models/CourseEmailAttendeesPatch';
33
34
  export type { CoursePage } from './models/CoursePage';
34
35
  export type { CoursePatch } from './models/CoursePatch';
35
36
  export type { CoursePost } from './models/CoursePost';
@@ -126,6 +127,7 @@ export type { OpportunityRegister } from './models/OpportunityRegister';
126
127
  export type { OpportunityRegisterPage } from './models/OpportunityRegisterPage';
127
128
  export type { OpportunityRegisterPatch } from './models/OpportunityRegisterPatch';
128
129
  export type { OpportunityRegisterPost } from './models/OpportunityRegisterPost';
130
+ export { OpportunityRegisterStatus } from './models/OpportunityRegisterStatus';
129
131
  export { OpportunityType } from './models/OpportunityType';
130
132
  export type { Order } from './models/Order';
131
133
  export type { OrderEmailCustomerPatch } from './models/OrderEmailCustomerPatch';
@@ -6,7 +6,7 @@
6
6
  import type { Surface } from './Surface';
7
7
 
8
8
  /**
9
- * Represents a Country within the Reach application.
9
+ * Represents an activity category within the Reach application.
10
10
  */
11
11
  export type Activity = {
12
12
  /**
@@ -0,0 +1,22 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ /**
7
+ * Post model for email course attendees.
8
+ */
9
+ export type CourseEmailAttendeesPatch = {
10
+ /**
11
+ * Gets or sets the tenant Id.
12
+ */
13
+ tenantId: string;
14
+ /**
15
+ * Gets or sets the Id.
16
+ */
17
+ id: string;
18
+ /**
19
+ * Gets or sets the message body.
20
+ */
21
+ message?: string | null;
22
+ };
@@ -11,6 +11,7 @@ import type { Image } from './Image';
11
11
  import type { IOpportunity } from './IOpportunity';
12
12
  import type { Offer } from './Offer';
13
13
  import type { Programme } from './Programme';
14
+ import type { Tenant } from './Tenant';
14
15
  import type { Venue } from './Venue';
15
16
  import type { WaitlistActivity } from './WaitlistActivity';
16
17
 
@@ -105,6 +106,7 @@ export type GenericActivity = {
105
106
  */
106
107
  endDateTime?: string | null;
107
108
  nextAvailableOpportunity?: IOpportunity;
109
+ tenant?: Tenant;
108
110
  venue?: Venue;
109
111
  activity?: Activity;
110
112
  programme?: Programme;
@@ -5,6 +5,7 @@
5
5
 
6
6
  import type { Attendee } from './Attendee';
7
7
  import type { Course } from './Course';
8
+ import type { OpportunityRegisterStatus } from './OpportunityRegisterStatus';
8
9
  import type { OrderItem } from './OrderItem';
9
10
  import type { ScheduledSession } from './ScheduledSession';
10
11
 
@@ -68,6 +69,7 @@ export type OpportunityRegister = {
68
69
  * Gets or sets the opportunity id that the attendee was moved from.
69
70
  */
70
71
  movedFrom?: string | null;
72
+ status?: OpportunityRegisterStatus;
71
73
  attendee?: Attendee;
72
74
  orderItem?: OrderItem;
73
75
  scheduledSession?: ScheduledSession;
@@ -0,0 +1,12 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ /**
7
+ * The opportunity status.
8
+ */
9
+ export enum OpportunityRegisterStatus {
10
+ ACTIVE = 'Active',
11
+ CANCELLED = 'Cancelled',
12
+ }
@@ -208,6 +208,10 @@ export type Order = {
208
208
  * Gets or sets a value indicating whether the payment require notifications to be sent.
209
209
  */
210
210
  requiresPaymentNotification: boolean;
211
+ /**
212
+ * Gets or sets the checkout url.
213
+ */
214
+ checkoutUrl?: string | null;
211
215
  /**
212
216
  * Gets or sets the orders stripe payment intent client secret.
213
217
  */
@@ -4,6 +4,7 @@
4
4
  /* eslint-disable */
5
5
 
6
6
  import type { Course } from './Course';
7
+ import type { CustomerCancellationOption } from './CustomerCancellationOption';
7
8
  import type { IOpportunity } from './IOpportunity';
8
9
  import type { Offer } from './Offer';
9
10
  import type { OpportunityType } from './OpportunityType';
@@ -100,4 +101,5 @@ export type OrderItem = {
100
101
  offer?: Offer;
101
102
  opportunityType?: OpportunityType;
102
103
  opportunity?: IOpportunity;
104
+ cancellable?: CustomerCancellationOption;
103
105
  };
@@ -12,6 +12,10 @@ import type { PlaceGeometry } from './PlaceGeometry';
12
12
  */
13
13
  export type PlaceResult = {
14
14
  geometry?: PlaceGeometry;
15
+ /**
16
+ * Gets or sets the name.
17
+ */
18
+ name?: string | null;
15
19
  place_address?: PlaceAddress;
16
20
  /**
17
21
  * Gets or sets the address components.
@@ -4,7 +4,7 @@
4
4
  /* eslint-disable */
5
5
 
6
6
  /**
7
- * Post model for scheduled session rescheduling updates.
7
+ * Post model for emailing scheduled session attendees.
8
8
  */
9
9
  export type ScheduledSessionEmailAttendeesPatch = {
10
10
  /**
@@ -5,10 +5,12 @@
5
5
  import type { BookingStatus } from '../models/BookingStatus';
6
6
  import type { Course } from '../models/Course';
7
7
  import type { CourseCreate } from '../models/CourseCreate';
8
+ import type { CourseEmailAttendeesPatch } from '../models/CourseEmailAttendeesPatch';
8
9
  import type { CoursePage } from '../models/CoursePage';
9
10
  import type { CoursePatch } from '../models/CoursePatch';
10
11
  import type { CoursePost } from '../models/CoursePost';
11
12
  import type { CourseSearchSortBy } from '../models/CourseSearchSortBy';
13
+ import type { ScheduledSession } from '../models/ScheduledSession';
12
14
  import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
13
15
 
14
16
  import type { CancelablePromise } from '../core/CancelablePromise';
@@ -141,6 +143,40 @@ export class CoursesService {
141
143
  });
142
144
  }
143
145
 
146
+ /**
147
+ * Emails all attendees booked onto the opportunity />.
148
+ * @returns ScheduledSession Success
149
+ * @throws ApiError
150
+ */
151
+ public contactAttendees({
152
+ courseId,
153
+ requestBody,
154
+ }: {
155
+ /**
156
+ * The course Id.
157
+ */
158
+ courseId: string;
159
+ /**
160
+ * The patch model.
161
+ */
162
+ requestBody?: CourseEmailAttendeesPatch;
163
+ }): CancelablePromise<ScheduledSession> {
164
+ return this.httpRequest.request({
165
+ method: 'PATCH',
166
+ url: '/api/courses/{courseId}/email-attendees',
167
+ path: {
168
+ courseId: courseId,
169
+ },
170
+ body: requestBody,
171
+ mediaType: 'application/json',
172
+ errors: {
173
+ 400: `Bad Request`,
174
+ 422: `Client Error`,
175
+ 500: `Server Error`,
176
+ },
177
+ });
178
+ }
179
+
144
180
  /**
145
181
  * Sends the post course completion email />.
146
182
  * @returns any Success
@@ -113,6 +113,48 @@ export class PublicOrdersService {
113
113
  });
114
114
  }
115
115
 
116
+ /**
117
+ * Cancels the order and requests a refund.
118
+ * @returns any Success
119
+ * @throws ApiError
120
+ */
121
+ public cancelWithRefund({
122
+ id,
123
+ xTenantSubdomain,
124
+ requestBody,
125
+ }: {
126
+ /**
127
+ * The order id.
128
+ */
129
+ id: string;
130
+ /**
131
+ * The tenants subdomain.
132
+ */
133
+ xTenantSubdomain?: string;
134
+ /**
135
+ * The order items in the case of a partial refund.
136
+ */
137
+ requestBody?: Array<string>;
138
+ }): CancelablePromise<any> {
139
+ return this.httpRequest.request({
140
+ method: 'POST',
141
+ url: '/api/public/orders/{id}/cancel-with-refund',
142
+ path: {
143
+ id: id,
144
+ },
145
+ headers: {
146
+ x_tenant_subdomain: xTenantSubdomain,
147
+ },
148
+ body: requestBody,
149
+ mediaType: 'application/json',
150
+ errors: {
151
+ 400: `Bad Request`,
152
+ 422: `Client Error`,
153
+ 500: `Server Error`,
154
+ },
155
+ });
156
+ }
157
+
116
158
  /**
117
159
  * Returns a value indicating whether the resource exists in the database given the provided search params.
118
160
  * @returns boolean Success
@@ -19,7 +19,7 @@ export class PublicTenantsService {
19
19
  * @returns Tenant Success
20
20
  * @throws ApiError
21
21
  */
22
- public getObject({
22
+ public init({
23
23
  xTenantSubdomain,
24
24
  }: {
25
25
  /**
@@ -41,12 +41,39 @@ export class PublicTenantsService {
41
41
  });
42
42
  }
43
43
 
44
+ /**
45
+ * Gets a Reach.Models.Tenant by its subdomain.
46
+ * @returns Tenant Success
47
+ * @throws ApiError
48
+ */
49
+ public initById({
50
+ id,
51
+ }: {
52
+ /**
53
+ * The tenants id.
54
+ */
55
+ id: string;
56
+ }): CancelablePromise<Tenant> {
57
+ return this.httpRequest.request({
58
+ method: 'GET',
59
+ url: '/api/public/tenants/init/{id}',
60
+ path: {
61
+ id: id,
62
+ },
63
+ errors: {
64
+ 400: `Bad Request`,
65
+ 422: `Client Error`,
66
+ 500: `Server Error`,
67
+ },
68
+ });
69
+ }
70
+
44
71
  /**
45
72
  * Gets the resource by its Id.
46
73
  * @returns Tenant Success
47
74
  * @throws ApiError
48
75
  */
49
- public getObject1({
76
+ public getObject({
50
77
  id,
51
78
  xTenantSubdomain,
52
79
  }: {