reach-api-sdk 1.0.99 → 1.0.101

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.
@@ -4093,6 +4093,10 @@ type OrderItem = {
4093
4093
  opportunityType?: OpportunityType;
4094
4094
  opportunity?: IOpportunity;
4095
4095
  cancellable?: CustomerCancellationOption;
4096
+ /**
4097
+ * Gets or sets a value indicating whether the order item is refundable.
4098
+ */
4099
+ refundable?: boolean | null;
4096
4100
  };
4097
4101
 
4098
4102
  /**
@@ -5818,6 +5822,21 @@ declare class CoursesService {
5818
5822
  * @throws ApiError
5819
5823
  */
5820
5824
  generateId(): CancelablePromise<string>;
5825
+ /**
5826
+ * Changes the capacity of a course />.
5827
+ * @returns Course Success
5828
+ * @throws ApiError
5829
+ */
5830
+ changeCapacity({ courseId, capacity, }: {
5831
+ /**
5832
+ * The course Id.
5833
+ */
5834
+ courseId: string;
5835
+ /**
5836
+ * The new capacity.
5837
+ */
5838
+ capacity: number;
5839
+ }): CancelablePromise<Course>;
5821
5840
  /**
5822
5841
  * Emails all attendees booked onto the opportunity />.
5823
5842
  * @returns ScheduledSession Success
@@ -5844,6 +5863,17 @@ declare class CoursesService {
5844
5863
  */
5845
5864
  courseId: string;
5846
5865
  }): CancelablePromise<any>;
5866
+ /**
5867
+ * Cancels the course />.
5868
+ * @returns Course Success
5869
+ * @throws ApiError
5870
+ */
5871
+ cancel({ courseId, }: {
5872
+ /**
5873
+ * The course Id.
5874
+ */
5875
+ courseId: string;
5876
+ }): CancelablePromise<Course>;
5847
5877
  /**
5848
5878
  * Sends a batch of post completion emails.
5849
5879
  * @returns any Success
@@ -6553,6 +6583,32 @@ type CourseSessionPost = {
6553
6583
  capacityUnlimited?: boolean;
6554
6584
  };
6555
6585
 
6586
+ /**
6587
+ * Post model for course session rescheduling updates.
6588
+ */
6589
+ type CourseSessionReschedulePatch = {
6590
+ /**
6591
+ * Gets or sets the tenant Id.
6592
+ */
6593
+ tenantId: string;
6594
+ /**
6595
+ * Gets or sets the Id.
6596
+ */
6597
+ id: string;
6598
+ /**
6599
+ * Gets or sets the course session to start date time.
6600
+ */
6601
+ startDateTime: string;
6602
+ /**
6603
+ * Gets or sets the course session to duration.
6604
+ */
6605
+ durationMinutes?: number;
6606
+ /**
6607
+ * Gets or sets a value indicating whether to notify customers.
6608
+ */
6609
+ notifyCustomers?: boolean;
6610
+ };
6611
+
6556
6612
  declare class CourseSessionsService {
6557
6613
  readonly httpRequest: BaseHttpRequest;
6558
6614
  constructor(httpRequest: BaseHttpRequest);
@@ -6567,6 +6623,21 @@ declare class CourseSessionsService {
6567
6623
  */
6568
6624
  courseSessionId: string;
6569
6625
  }): CancelablePromise<CourseSession>;
6626
+ /**
6627
+ * Reschedules the course session />.
6628
+ * @returns CourseSession Success
6629
+ * @throws ApiError
6630
+ */
6631
+ reschedule({ courseSessionId, requestBody, }: {
6632
+ /**
6633
+ * The course session Id.
6634
+ */
6635
+ courseSessionId: string;
6636
+ /**
6637
+ * The model for the new opportunity dates and times.
6638
+ */
6639
+ requestBody?: CourseSessionReschedulePatch;
6640
+ }): CancelablePromise<CourseSession>;
6570
6641
  /**
6571
6642
  * Cleans table of leased and conflicted course sessions.
6572
6643
  * @returns number Success
@@ -20096,6 +20167,25 @@ declare class PublicOrdersService {
20096
20167
  */
20097
20168
  requestBody?: Array<string>;
20098
20169
  }): CancelablePromise<any>;
20170
+ /**
20171
+ * Cancels the order.
20172
+ * @returns any Success
20173
+ * @throws ApiError
20174
+ */
20175
+ cancel({ id, xTenantSubdomain, requestBody, }: {
20176
+ /**
20177
+ * The order id.
20178
+ */
20179
+ id: string;
20180
+ /**
20181
+ * The tenants subdomain.
20182
+ */
20183
+ xTenantSubdomain?: string;
20184
+ /**
20185
+ * The order items in the case of a partial refund.
20186
+ */
20187
+ requestBody?: Array<string>;
20188
+ }): CancelablePromise<any>;
20099
20189
  /**
20100
20190
  * Returns a value indicating whether the resource exists in the database given the provided search params.
20101
20191
  * @returns boolean Success
@@ -39427,4 +39517,4 @@ type ValidationResultModel = {
39427
39517
  readonly errors?: Array<ValidationError> | null;
39428
39518
  };
39429
39519
 
39430
- 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, WaitlistActivityReport, WaitlistActivityReportPage, WaitlistActivityReportPatch, WaitlistActivityReportPost, WaitlistActivityReportService, WaitlistActivityService, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityPatch, WaitlistOpportunityPost, WaitlistOpportunityReport, WaitlistOpportunityReportPage, WaitlistOpportunityReportPatch, WaitlistOpportunityReportPost, WaitlistOpportunityReportService, WaitlistOpportunityService };
39520
+ 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, CourseSessionReschedulePatch, 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, WaitlistActivityReport, WaitlistActivityReportPage, WaitlistActivityReportPatch, WaitlistActivityReportPost, WaitlistActivityReportService, WaitlistActivityService, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityPatch, WaitlistOpportunityPost, WaitlistOpportunityReport, WaitlistOpportunityReportPage, WaitlistOpportunityReportPatch, WaitlistOpportunityReportPost, WaitlistOpportunityReportService, WaitlistOpportunityService };
package/dist/reach-sdk.js CHANGED
@@ -2059,6 +2059,29 @@ const request = (config, options, axiosClient = axios) => {
2059
2059
  }
2060
2060
  });
2061
2061
  }
2062
+ /**
2063
+ * Changes the capacity of a course />.
2064
+ * @returns Course Success
2065
+ * @throws ApiError
2066
+ */
2067
+ changeCapacity({
2068
+ courseId,
2069
+ capacity
2070
+ }) {
2071
+ return this.httpRequest.request({
2072
+ method: "PATCH",
2073
+ url: "/api/courses/{courseId}/change-capacity/{capacity}",
2074
+ path: {
2075
+ courseId,
2076
+ capacity
2077
+ },
2078
+ errors: {
2079
+ 400: `Bad Request`,
2080
+ 422: `Client Error`,
2081
+ 500: `Server Error`
2082
+ }
2083
+ });
2084
+ }
2062
2085
  /**
2063
2086
  * Emails all attendees booked onto the opportunity />.
2064
2087
  * @returns ScheduledSession Success
@@ -2104,6 +2127,27 @@ const request = (config, options, axiosClient = axios) => {
2104
2127
  }
2105
2128
  });
2106
2129
  }
2130
+ /**
2131
+ * Cancels the course />.
2132
+ * @returns Course Success
2133
+ * @throws ApiError
2134
+ */
2135
+ cancel({
2136
+ courseId
2137
+ }) {
2138
+ return this.httpRequest.request({
2139
+ method: "PATCH",
2140
+ url: "/api/courses/{courseId}/cancel",
2141
+ path: {
2142
+ courseId
2143
+ },
2144
+ errors: {
2145
+ 400: `Bad Request`,
2146
+ 422: `Client Error`,
2147
+ 500: `Server Error`
2148
+ }
2149
+ });
2150
+ }
2107
2151
  /**
2108
2152
  * Sends a batch of post completion emails.
2109
2153
  * @returns any Success
@@ -2648,6 +2692,30 @@ const request = (config, options, axiosClient = axios) => {
2648
2692
  }
2649
2693
  });
2650
2694
  }
2695
+ /**
2696
+ * Reschedules the course session />.
2697
+ * @returns CourseSession Success
2698
+ * @throws ApiError
2699
+ */
2700
+ reschedule({
2701
+ courseSessionId,
2702
+ requestBody
2703
+ }) {
2704
+ return this.httpRequest.request({
2705
+ method: "PATCH",
2706
+ url: "/api/course-sessions/{courseSessionId}/reschedule",
2707
+ path: {
2708
+ courseSessionId
2709
+ },
2710
+ body: requestBody,
2711
+ mediaType: "application/json",
2712
+ errors: {
2713
+ 400: `Bad Request`,
2714
+ 422: `Client Error`,
2715
+ 500: `Server Error`
2716
+ }
2717
+ });
2718
+ }
2651
2719
  /**
2652
2720
  * Cleans table of leased and conflicted course sessions.
2653
2721
  * @returns number Success
@@ -13862,6 +13930,34 @@ const request = (config, options, axiosClient = axios) => {
13862
13930
  }
13863
13931
  });
13864
13932
  }
13933
+ /**
13934
+ * Cancels the order.
13935
+ * @returns any Success
13936
+ * @throws ApiError
13937
+ */
13938
+ cancel({
13939
+ id,
13940
+ xTenantSubdomain,
13941
+ requestBody
13942
+ }) {
13943
+ return this.httpRequest.request({
13944
+ method: "POST",
13945
+ url: "/api/public/orders/{id}/cancel",
13946
+ path: {
13947
+ id
13948
+ },
13949
+ headers: {
13950
+ x_tenant_subdomain: xTenantSubdomain
13951
+ },
13952
+ body: requestBody,
13953
+ mediaType: "application/json",
13954
+ errors: {
13955
+ 400: `Bad Request`,
13956
+ 422: `Client Error`,
13957
+ 500: `Server Error`
13958
+ }
13959
+ });
13960
+ }
13865
13961
  /**
13866
13962
  * Returns a value indicating whether the resource exists in the database given the provided search params.
13867
13963
  * @returns boolean Success
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "reach-api-sdk",
3
- "version": "1.0.99",
3
+ "version": "1.0.101",
4
4
  "description": "sdk for reach api",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -5049,6 +5049,76 @@ paths:
5049
5049
  text/json:
5050
5050
  schema:
5051
5051
  $ref: '#/components/schemas/ValidationResultModel'
5052
+ '/api/courses/{courseId}/change-capacity/{capacity}':
5053
+ patch:
5054
+ tags:
5055
+ - Courses
5056
+ summary: Changes the capacity of a course />.
5057
+ operationId: ChangeCapacity
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
+ - name: capacity
5067
+ in: path
5068
+ description: The new capacity.
5069
+ required: true
5070
+ schema:
5071
+ type: integer
5072
+ format: int32
5073
+ responses:
5074
+ '200':
5075
+ description: Success
5076
+ content:
5077
+ text/plain:
5078
+ schema:
5079
+ $ref: '#/components/schemas/Course'
5080
+ application/json:
5081
+ schema:
5082
+ $ref: '#/components/schemas/Course'
5083
+ text/json:
5084
+ schema:
5085
+ $ref: '#/components/schemas/Course'
5086
+ '400':
5087
+ description: Bad Request
5088
+ content:
5089
+ text/plain:
5090
+ schema:
5091
+ $ref: '#/components/schemas/ReachError'
5092
+ application/json:
5093
+ schema:
5094
+ $ref: '#/components/schemas/ReachError'
5095
+ text/json:
5096
+ schema:
5097
+ $ref: '#/components/schemas/ReachError'
5098
+ '500':
5099
+ description: Server Error
5100
+ content:
5101
+ text/plain:
5102
+ schema:
5103
+ $ref: '#/components/schemas/ReachError'
5104
+ application/json:
5105
+ schema:
5106
+ $ref: '#/components/schemas/ReachError'
5107
+ text/json:
5108
+ schema:
5109
+ $ref: '#/components/schemas/ReachError'
5110
+ '422':
5111
+ description: Client Error
5112
+ content:
5113
+ text/plain:
5114
+ schema:
5115
+ $ref: '#/components/schemas/ValidationResultModel'
5116
+ application/json:
5117
+ schema:
5118
+ $ref: '#/components/schemas/ValidationResultModel'
5119
+ text/json:
5120
+ schema:
5121
+ $ref: '#/components/schemas/ValidationResultModel'
5052
5122
  '/api/courses/{courseId}/email-attendees':
5053
5123
  patch:
5054
5124
  tags:
@@ -5177,6 +5247,69 @@ paths:
5177
5247
  text/json:
5178
5248
  schema:
5179
5249
  $ref: '#/components/schemas/ValidationResultModel'
5250
+ '/api/courses/{courseId}/cancel':
5251
+ patch:
5252
+ tags:
5253
+ - Courses
5254
+ summary: Cancels the course />.
5255
+ operationId: Cancel
5256
+ parameters:
5257
+ - name: courseId
5258
+ in: path
5259
+ description: The course Id.
5260
+ required: true
5261
+ schema:
5262
+ type: string
5263
+ format: uuid
5264
+ responses:
5265
+ '200':
5266
+ description: Success
5267
+ content:
5268
+ text/plain:
5269
+ schema:
5270
+ $ref: '#/components/schemas/Course'
5271
+ application/json:
5272
+ schema:
5273
+ $ref: '#/components/schemas/Course'
5274
+ text/json:
5275
+ schema:
5276
+ $ref: '#/components/schemas/Course'
5277
+ '400':
5278
+ description: Bad Request
5279
+ content:
5280
+ text/plain:
5281
+ schema:
5282
+ $ref: '#/components/schemas/ReachError'
5283
+ application/json:
5284
+ schema:
5285
+ $ref: '#/components/schemas/ReachError'
5286
+ text/json:
5287
+ schema:
5288
+ $ref: '#/components/schemas/ReachError'
5289
+ '500':
5290
+ description: Server Error
5291
+ content:
5292
+ text/plain:
5293
+ schema:
5294
+ $ref: '#/components/schemas/ReachError'
5295
+ application/json:
5296
+ schema:
5297
+ $ref: '#/components/schemas/ReachError'
5298
+ text/json:
5299
+ schema:
5300
+ $ref: '#/components/schemas/ReachError'
5301
+ '422':
5302
+ description: Client Error
5303
+ content:
5304
+ text/plain:
5305
+ schema:
5306
+ $ref: '#/components/schemas/ValidationResultModel'
5307
+ application/json:
5308
+ schema:
5309
+ $ref: '#/components/schemas/ValidationResultModel'
5310
+ text/json:
5311
+ schema:
5312
+ $ref: '#/components/schemas/ValidationResultModel'
5180
5313
  /api/courses/send-post-completion-emails:
5181
5314
  get:
5182
5315
  tags:
@@ -6782,6 +6915,81 @@ paths:
6782
6915
  text/json:
6783
6916
  schema:
6784
6917
  $ref: '#/components/schemas/ValidationResultModel'
6918
+ '/api/course-sessions/{courseSessionId}/reschedule':
6919
+ patch:
6920
+ tags:
6921
+ - CourseSessions
6922
+ summary: Reschedules the course session />.
6923
+ operationId: Reschedule
6924
+ parameters:
6925
+ - name: courseSessionId
6926
+ in: path
6927
+ description: The course session Id.
6928
+ required: true
6929
+ schema:
6930
+ type: string
6931
+ format: uuid
6932
+ requestBody:
6933
+ description: The model for the new opportunity dates and times.
6934
+ content:
6935
+ application/json:
6936
+ schema:
6937
+ $ref: '#/components/schemas/CourseSessionReschedulePatch'
6938
+ text/json:
6939
+ schema:
6940
+ $ref: '#/components/schemas/CourseSessionReschedulePatch'
6941
+ application/*+json:
6942
+ schema:
6943
+ $ref: '#/components/schemas/CourseSessionReschedulePatch'
6944
+ responses:
6945
+ '200':
6946
+ description: Success
6947
+ content:
6948
+ text/plain:
6949
+ schema:
6950
+ $ref: '#/components/schemas/CourseSession'
6951
+ application/json:
6952
+ schema:
6953
+ $ref: '#/components/schemas/CourseSession'
6954
+ text/json:
6955
+ schema:
6956
+ $ref: '#/components/schemas/CourseSession'
6957
+ '400':
6958
+ description: Bad Request
6959
+ content:
6960
+ text/plain:
6961
+ schema:
6962
+ $ref: '#/components/schemas/ReachError'
6963
+ application/json:
6964
+ schema:
6965
+ $ref: '#/components/schemas/ReachError'
6966
+ text/json:
6967
+ schema:
6968
+ $ref: '#/components/schemas/ReachError'
6969
+ '500':
6970
+ description: Server Error
6971
+ content:
6972
+ text/plain:
6973
+ schema:
6974
+ $ref: '#/components/schemas/ReachError'
6975
+ application/json:
6976
+ schema:
6977
+ $ref: '#/components/schemas/ReachError'
6978
+ text/json:
6979
+ schema:
6980
+ $ref: '#/components/schemas/ReachError'
6981
+ '422':
6982
+ description: Client Error
6983
+ content:
6984
+ text/plain:
6985
+ schema:
6986
+ $ref: '#/components/schemas/ValidationResultModel'
6987
+ application/json:
6988
+ schema:
6989
+ $ref: '#/components/schemas/ValidationResultModel'
6990
+ text/json:
6991
+ schema:
6992
+ $ref: '#/components/schemas/ValidationResultModel'
6785
6993
  /api/course-sessions/clean:
6786
6994
  get:
6787
6995
  tags:
@@ -40187,6 +40395,85 @@ paths:
40187
40395
  text/json:
40188
40396
  schema:
40189
40397
  $ref: '#/components/schemas/ValidationResultModel'
40398
+ '/api/public/orders/{id}/cancel':
40399
+ post:
40400
+ tags:
40401
+ - PublicOrders
40402
+ summary: Cancels the order.
40403
+ operationId: Cancel
40404
+ parameters:
40405
+ - name: x_tenant_subdomain
40406
+ in: header
40407
+ description: The tenants subdomain.
40408
+ schema:
40409
+ type: string
40410
+ - name: id
40411
+ in: path
40412
+ description: The order id.
40413
+ required: true
40414
+ schema:
40415
+ type: string
40416
+ format: uuid
40417
+ requestBody:
40418
+ description: The order items in the case of a partial refund.
40419
+ content:
40420
+ application/json:
40421
+ schema:
40422
+ type: array
40423
+ items:
40424
+ type: string
40425
+ format: uuid
40426
+ text/json:
40427
+ schema:
40428
+ type: array
40429
+ items:
40430
+ type: string
40431
+ format: uuid
40432
+ application/*+json:
40433
+ schema:
40434
+ type: array
40435
+ items:
40436
+ type: string
40437
+ format: uuid
40438
+ responses:
40439
+ '200':
40440
+ description: Success
40441
+ '400':
40442
+ description: Bad Request
40443
+ content:
40444
+ text/plain:
40445
+ schema:
40446
+ $ref: '#/components/schemas/ReachError'
40447
+ application/json:
40448
+ schema:
40449
+ $ref: '#/components/schemas/ReachError'
40450
+ text/json:
40451
+ schema:
40452
+ $ref: '#/components/schemas/ReachError'
40453
+ '500':
40454
+ description: Server Error
40455
+ content:
40456
+ text/plain:
40457
+ schema:
40458
+ $ref: '#/components/schemas/ReachError'
40459
+ application/json:
40460
+ schema:
40461
+ $ref: '#/components/schemas/ReachError'
40462
+ text/json:
40463
+ schema:
40464
+ $ref: '#/components/schemas/ReachError'
40465
+ '422':
40466
+ description: Client Error
40467
+ content:
40468
+ text/plain:
40469
+ schema:
40470
+ $ref: '#/components/schemas/ValidationResultModel'
40471
+ application/json:
40472
+ schema:
40473
+ $ref: '#/components/schemas/ValidationResultModel'
40474
+ text/json:
40475
+ schema:
40476
+ $ref: '#/components/schemas/ValidationResultModel'
40190
40477
  /api/public/orders/exists:
40191
40478
  get:
40192
40479
  tags:
@@ -89470,6 +89757,36 @@ components:
89470
89757
  default: false
89471
89758
  additionalProperties: false
89472
89759
  description: Post model for course inserts.
89760
+ CourseSessionReschedulePatch:
89761
+ required:
89762
+ - id
89763
+ - startDateTime
89764
+ - tenantId
89765
+ type: object
89766
+ properties:
89767
+ tenantId:
89768
+ type: string
89769
+ description: Gets or sets the tenant Id.
89770
+ format: uuid
89771
+ id:
89772
+ type: string
89773
+ description: Gets or sets the Id.
89774
+ format: uuid
89775
+ startDateTime:
89776
+ type: string
89777
+ description: Gets or sets the course session to start date time.
89778
+ format: date-time
89779
+ durationMinutes:
89780
+ type: integer
89781
+ description: Gets or sets the course session to duration.
89782
+ format: int32
89783
+ default: 0
89784
+ notifyCustomers:
89785
+ type: boolean
89786
+ description: Gets or sets a value indicating whether to notify customers.
89787
+ default: false
89788
+ additionalProperties: false
89789
+ description: Post model for course session rescheduling updates.
89473
89790
  CourseSessionSchedule:
89474
89791
  required:
89475
89792
  - dateCreated
@@ -92789,6 +93106,10 @@ components:
92789
93106
  $ref: '#/components/schemas/IOpportunity'
92790
93107
  cancellable:
92791
93108
  $ref: '#/components/schemas/CustomerCancellationOption'
93109
+ refundable:
93110
+ type: boolean
93111
+ description: Gets or sets a value indicating whether the order item is refundable.
93112
+ nullable: true
92792
93113
  additionalProperties: false
92793
93114
  description: Represents an Order of a currently available bookable Reach.Models.OrderItem.Slot within the Reach application.
92794
93115
  OrderItemPage:
package/src/index.ts CHANGED
@@ -39,6 +39,7 @@ export type { CourseSession } from './models/CourseSession';
39
39
  export type { CourseSessionPage } from './models/CourseSessionPage';
40
40
  export type { CourseSessionPatch } from './models/CourseSessionPatch';
41
41
  export type { CourseSessionPost } from './models/CourseSessionPost';
42
+ export type { CourseSessionReschedulePatch } from './models/CourseSessionReschedulePatch';
42
43
  export type { CourseSessionSchedule } from './models/CourseSessionSchedule';
43
44
  export type { CourseSessionSchedulePage } from './models/CourseSessionSchedulePage';
44
45
  export type { CourseSessionSchedulePatch } from './models/CourseSessionSchedulePatch';
@@ -0,0 +1,30 @@
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 course session rescheduling updates.
8
+ */
9
+ export type CourseSessionReschedulePatch = {
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 course session to start date time.
20
+ */
21
+ startDateTime: string;
22
+ /**
23
+ * Gets or sets the course session to duration.
24
+ */
25
+ durationMinutes?: number;
26
+ /**
27
+ * Gets or sets a value indicating whether to notify customers.
28
+ */
29
+ notifyCustomers?: boolean;
30
+ };
@@ -102,4 +102,8 @@ export type OrderItem = {
102
102
  opportunityType?: OpportunityType;
103
103
  opportunity?: IOpportunity;
104
104
  cancellable?: CustomerCancellationOption;
105
+ /**
106
+ * Gets or sets a value indicating whether the order item is refundable.
107
+ */
108
+ refundable?: boolean | null;
105
109
  };
@@ -6,6 +6,7 @@ import type { CourseSession } from '../models/CourseSession';
6
6
  import type { CourseSessionPage } from '../models/CourseSessionPage';
7
7
  import type { CourseSessionPatch } from '../models/CourseSessionPatch';
8
8
  import type { CourseSessionPost } from '../models/CourseSessionPost';
9
+ import type { CourseSessionReschedulePatch } from '../models/CourseSessionReschedulePatch';
9
10
  import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
10
11
  import type { SlotStatus } from '../models/SlotStatus';
11
12
 
@@ -42,6 +43,40 @@ export class CourseSessionsService {
42
43
  });
43
44
  }
44
45
 
46
+ /**
47
+ * Reschedules the course session />.
48
+ * @returns CourseSession Success
49
+ * @throws ApiError
50
+ */
51
+ public reschedule({
52
+ courseSessionId,
53
+ requestBody,
54
+ }: {
55
+ /**
56
+ * The course session Id.
57
+ */
58
+ courseSessionId: string;
59
+ /**
60
+ * The model for the new opportunity dates and times.
61
+ */
62
+ requestBody?: CourseSessionReschedulePatch;
63
+ }): CancelablePromise<CourseSession> {
64
+ return this.httpRequest.request({
65
+ method: 'PATCH',
66
+ url: '/api/course-sessions/{courseSessionId}/reschedule',
67
+ path: {
68
+ courseSessionId: courseSessionId,
69
+ },
70
+ body: requestBody,
71
+ mediaType: 'application/json',
72
+ errors: {
73
+ 400: `Bad Request`,
74
+ 422: `Client Error`,
75
+ 500: `Server Error`,
76
+ },
77
+ });
78
+ }
79
+
45
80
  /**
46
81
  * Cleans table of leased and conflicted course sessions.
47
82
  * @returns number Success
@@ -143,6 +143,39 @@ export class CoursesService {
143
143
  });
144
144
  }
145
145
 
146
+ /**
147
+ * Changes the capacity of a course />.
148
+ * @returns Course Success
149
+ * @throws ApiError
150
+ */
151
+ public changeCapacity({
152
+ courseId,
153
+ capacity,
154
+ }: {
155
+ /**
156
+ * The course Id.
157
+ */
158
+ courseId: string;
159
+ /**
160
+ * The new capacity.
161
+ */
162
+ capacity: number;
163
+ }): CancelablePromise<Course> {
164
+ return this.httpRequest.request({
165
+ method: 'PATCH',
166
+ url: '/api/courses/{courseId}/change-capacity/{capacity}',
167
+ path: {
168
+ courseId: courseId,
169
+ capacity: capacity,
170
+ },
171
+ errors: {
172
+ 400: `Bad Request`,
173
+ 422: `Client Error`,
174
+ 500: `Server Error`,
175
+ },
176
+ });
177
+ }
178
+
146
179
  /**
147
180
  * Emails all attendees booked onto the opportunity />.
148
181
  * @returns ScheduledSession Success
@@ -204,6 +237,33 @@ export class CoursesService {
204
237
  });
205
238
  }
206
239
 
240
+ /**
241
+ * Cancels the course />.
242
+ * @returns Course Success
243
+ * @throws ApiError
244
+ */
245
+ public cancel({
246
+ courseId,
247
+ }: {
248
+ /**
249
+ * The course Id.
250
+ */
251
+ courseId: string;
252
+ }): CancelablePromise<Course> {
253
+ return this.httpRequest.request({
254
+ method: 'PATCH',
255
+ url: '/api/courses/{courseId}/cancel',
256
+ path: {
257
+ courseId: courseId,
258
+ },
259
+ errors: {
260
+ 400: `Bad Request`,
261
+ 422: `Client Error`,
262
+ 500: `Server Error`,
263
+ },
264
+ });
265
+ }
266
+
207
267
  /**
208
268
  * Sends a batch of post completion emails.
209
269
  * @returns any Success
@@ -155,6 +155,48 @@ export class PublicOrdersService {
155
155
  });
156
156
  }
157
157
 
158
+ /**
159
+ * Cancels the order.
160
+ * @returns any Success
161
+ * @throws ApiError
162
+ */
163
+ public cancel({
164
+ id,
165
+ xTenantSubdomain,
166
+ requestBody,
167
+ }: {
168
+ /**
169
+ * The order id.
170
+ */
171
+ id: string;
172
+ /**
173
+ * The tenants subdomain.
174
+ */
175
+ xTenantSubdomain?: string;
176
+ /**
177
+ * The order items in the case of a partial refund.
178
+ */
179
+ requestBody?: Array<string>;
180
+ }): CancelablePromise<any> {
181
+ return this.httpRequest.request({
182
+ method: 'POST',
183
+ url: '/api/public/orders/{id}/cancel',
184
+ path: {
185
+ id: id,
186
+ },
187
+ headers: {
188
+ x_tenant_subdomain: xTenantSubdomain,
189
+ },
190
+ body: requestBody,
191
+ mediaType: 'application/json',
192
+ errors: {
193
+ 400: `Bad Request`,
194
+ 422: `Client Error`,
195
+ 500: `Server Error`,
196
+ },
197
+ });
198
+ }
199
+
158
200
  /**
159
201
  * Returns a value indicating whether the resource exists in the database given the provided search params.
160
202
  * @returns boolean Success