reach-api-sdk 1.0.25 → 1.0.26

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.
@@ -1757,42 +1757,42 @@ type ScheduledSession = {
1757
1757
  /**
1758
1758
  * Gets a value indicating whether the slot is leased waiting confirmation to be made bookable by the Reach tenant. This status does not refer to a booking lease!.
1759
1759
  */
1760
- readonly isLeased?: boolean;
1760
+ readonly isLeased: boolean;
1761
1761
  /**
1762
1762
  * Gets a value indicating whether the slot has availability also considering leases.
1763
1763
  */
1764
- readonly hasAvailability?: boolean;
1764
+ readonly hasAvailability: boolean;
1765
1765
  /**
1766
1766
  * Gets the slots remaining uses when also considering Order leases. This is computed at runtime since order leases expire silently, that is, there is no process that recalculates remaining uses when an Order lease expiry is reached.
1767
1767
  */
1768
- readonly actualRemainingUses?: number | null;
1768
+ readonly actualRemainingUses: number;
1769
1769
  /**
1770
1770
  * Gets a value indicating whether the scheduled session is collidable.
1771
1771
  */
1772
- readonly isCollidable?: boolean;
1772
+ readonly isCollidable: boolean;
1773
1773
  /**
1774
1774
  * Gets a value indicating whether the scheduled session is expired due to passing the end date time.
1775
1775
  */
1776
- readonly isExpired?: boolean;
1776
+ readonly isExpired: boolean;
1777
1777
  /**
1778
1778
  * Gets a value indicating whether the scheduled session is booked.
1779
1779
  */
1780
- readonly isCreatedBySchedule?: boolean;
1780
+ readonly isCreatedBySchedule: boolean;
1781
1781
  /**
1782
1782
  * Gets a value indicating whether the scheduled session is deletable.
1783
1783
  */
1784
- readonly isDeletable?: boolean;
1785
- availabilityStatus?: SlotAvailabilityStatus;
1784
+ readonly isDeletable: boolean;
1785
+ availabilityStatus: SlotAvailabilityStatus;
1786
1786
  /**
1787
1787
  * Gets or sets the session id.
1788
1788
  */
1789
- sessionId?: string | null;
1790
- status?: SlotStatus;
1789
+ sessionId: string;
1790
+ status: SlotStatus;
1791
1791
  /**
1792
1792
  * Gets or sets the scheduled session creation lease expiry. Preventing other scheduled sessions from overwriting until the lease expires.
1793
1793
  */
1794
1794
  leaseExpiry?: string | null;
1795
- bookingStatus?: BookingStatus;
1795
+ bookingStatus: BookingStatus;
1796
1796
  /**
1797
1797
  * Gets or sets the scheduled session on confirmed conflicted description.
1798
1798
  */
@@ -1804,11 +1804,11 @@ type ScheduledSession = {
1804
1804
  /**
1805
1805
  * Gets or sets the scheduled session start date time in UTC as is the applications required convention. (this datetime must always be UTC).
1806
1806
  */
1807
- startDateTime?: string | null;
1807
+ startDateTime: string;
1808
1808
  /**
1809
1809
  * Gets or sets the scheduled session end date time in UTC as is the applications required convention. (this datetime must always be UTC).
1810
1810
  */
1811
- endDateTime?: string | null;
1811
+ endDateTime: string;
1812
1812
  /**
1813
1813
  * Gets the scheduled sessions period label.
1814
1814
  */
@@ -1820,23 +1820,23 @@ type ScheduledSession = {
1820
1820
  /**
1821
1821
  * Gets or sets the scheduled session duration.
1822
1822
  */
1823
- durationMinutes?: number;
1823
+ durationMinutes: number;
1824
1824
  /**
1825
1825
  * Gets or sets the scheduled session remaining uses. Defaults to 1.
1826
1826
  */
1827
- remainingUses?: number | null;
1827
+ remainingUses: number;
1828
1828
  /**
1829
1829
  * Gets or sets the scheduled sessions capacity.
1830
1830
  */
1831
- capacity?: number | null;
1831
+ capacity: number;
1832
1832
  /**
1833
1833
  * Gets or sets a value indicating whether the post activity completion email has been sent.
1834
1834
  */
1835
- postCompletionEmailSent?: boolean;
1835
+ postCompletionEmailSent: boolean;
1836
1836
  /**
1837
1837
  * Gets a value indicating whether this scheduled session has unlimited capacity.
1838
1838
  */
1839
- readonly capacityUnlimited?: boolean | null;
1839
+ readonly capacityUnlimited: boolean;
1840
1840
  session?: Session;
1841
1841
  scheduledSessionSchedule?: ScheduledSessionSchedule;
1842
1842
  /**
@@ -3764,6 +3764,32 @@ type OrderPatch = {
3764
3764
  id: string;
3765
3765
  };
3766
3766
 
3767
+ /**
3768
+ * Post model for session offers.
3769
+ */
3770
+ type OrderPostOrderItem = {
3771
+ /**
3772
+ * Gets or sets the slot id.
3773
+ */
3774
+ slotId?: string | null;
3775
+ /**
3776
+ * Gets or sets the scheduled session id.
3777
+ */
3778
+ scheduledSessionId?: string | null;
3779
+ /**
3780
+ * Gets or sets the course id.
3781
+ */
3782
+ courseId?: string | null;
3783
+ /**
3784
+ * Gets or sets the offer id.
3785
+ */
3786
+ offerId: string;
3787
+ /**
3788
+ * Gets or sets the quantity of opportunities required on the order item.
3789
+ */
3790
+ quantity?: number | null;
3791
+ };
3792
+
3767
3793
  /**
3768
3794
  * Post model for order inserts.
3769
3795
  */
@@ -3772,6 +3798,54 @@ type OrderPost = {
3772
3798
  * Gets or sets the tenant Id.
3773
3799
  */
3774
3800
  tenantId: string;
3801
+ /**
3802
+ * Gets or sets the venue Id.
3803
+ */
3804
+ venueId: string;
3805
+ /**
3806
+ * Gets or sets the first name.
3807
+ */
3808
+ firstName: string;
3809
+ /**
3810
+ * Gets or sets the last name.
3811
+ */
3812
+ lastName: string;
3813
+ /**
3814
+ * Gets or sets the email.
3815
+ */
3816
+ email: string;
3817
+ /**
3818
+ * Gets or sets the phone number.
3819
+ */
3820
+ phone?: string | null;
3821
+ /**
3822
+ * Gets or sets the orders postcode.
3823
+ */
3824
+ addressPostalcode: string;
3825
+ /**
3826
+ * Gets or sets a value indicating whether the order and its associated slots have been created on demand within the order operation (e.g from a block booking).
3827
+ */
3828
+ isOndemand?: boolean | null;
3829
+ /**
3830
+ * Gets or sets a value indicating whether the order will ignore the maximum capacity of the ordered sessions.
3831
+ */
3832
+ allowOrderItemOverages?: boolean | null;
3833
+ /**
3834
+ * Gets or sets any private notes for the order.
3835
+ */
3836
+ privateNotes?: string | null;
3837
+ /**
3838
+ * Gets or sets the orders stripe payment intent client secret.
3839
+ */
3840
+ paymentIntentClientSecret?: string | null;
3841
+ /**
3842
+ * Gets or sets a value indicating whether the payment will be taken at a later date.
3843
+ */
3844
+ payLater: boolean;
3845
+ /**
3846
+ * Gets or sets a value indicating whether the payment will be taken at a later date.
3847
+ */
3848
+ orderItems: Array<OrderPostOrderItem>;
3775
3849
  };
3776
3850
 
3777
3851
  declare class BookingService {
@@ -24253,13 +24327,13 @@ declare class SurveyReportExtendedService {
24253
24327
  */
24254
24328
  type CreateQuestionOption = {
24255
24329
  /**
24256
- * Gets or sets the survey question client identifier, you can populate this with any unique value to help manage the question options array on the client, it is not required by the server.
24330
+ * Gets or sets the survey question option client identifier, you can populate this with any unique value to help manage the question options array on the client, it is not required by the server and will be ignored.
24257
24331
  */
24258
24332
  clientIdentifier?: string | null;
24259
24333
  /**
24260
24334
  * Gets or sets the survey question option name.
24261
24335
  */
24262
- name: string;
24336
+ name?: string | null;
24263
24337
  };
24264
24338
 
24265
24339
  /**
@@ -24267,7 +24341,7 @@ type CreateQuestionOption = {
24267
24341
  */
24268
24342
  type CreateQuestion = {
24269
24343
  /**
24270
- * Gets or sets the survey question client identifier, you can populate this with any unique value to help manage the questions array on the client, it is not required by the server.
24344
+ * Gets or sets the survey question client identifier, you can populate this with any unique value to help manage the questions array on the client, it is not required by the server and will be ignored.
24271
24345
  */
24272
24346
  clientIdentifier?: string | null;
24273
24347
  /**
@@ -25043,6 +25117,12 @@ type TenantWebsiteSettingPost = {
25043
25117
  declare class TenantWebsiteSettingsService {
25044
25118
  readonly httpRequest: BaseHttpRequest;
25045
25119
  constructor(httpRequest: BaseHttpRequest);
25120
+ /**
25121
+ * Gets the current tenant.
25122
+ * @returns Tenant Success
25123
+ * @throws ApiError
25124
+ */
25125
+ getTenantWebsiteSettings(): CancelablePromise<Tenant>;
25046
25126
  /**
25047
25127
  * Gets the resource by its Id.
25048
25128
  * @returns TenantWebsiteSetting Success
@@ -27819,4 +27899,4 @@ type ValidationResultModel = {
27819
27899
  readonly errors?: Array<ValidationError> | null;
27820
27900
  };
27821
27901
 
27822
- export { Activity, ActivityService, ActivityType, AdvanceBooking, Amenity, AmenityService, ApiClient, ApiError, AppUserRole, ApplicationRole, AutoCompleteResponseModel, BadEnglandReportService, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CoursePage, CoursePatch, CoursePost, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionPatch, CourseSessionPost, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulePatch, CourseSessionSchedulePost, CourseSessionSchedulesService, CourseSessionsService, CoursesService, CreateOffer, CreateQuestion, CreateQuestionOption, CreateVenue, Customer, CustomerCancellationOption, CustomerPage, CustomerPatch, CustomerPost, CustomerType, CustomersService, DayOfWeek, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulePatch, EmailReminderSchedulePost, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingPatch, EmailSettingPost, EmailSettingsService, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualPatch, FacilityIndividualPost, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, FacilityPatch, FacilityPost, FilestackImageMetaResponseModel, FilestackService, 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, OpportunityType, Order, OrderItem, OrderItemPage, OrderItemPatch, OrderItemPost, OrderItemStatus, OrderItemsService, OrderPage, OrderPatch, OrderPost, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrderTokenPatch, OrderTokenPost, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationPatch, OrgCourseUtilisationPost, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, Pagination, PatchSurveyQuestionOption, Payment, PaymentMethod, PaymentPage, PaymentPatch, PaymentPost, PaymentsService, Permission, PermissionPage, PermissionPatch, PermissionPost, PermissionsService, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammePatch, ProgrammePost, ProgrammesService, PublicBookingService, PublicCoursesService, PublicFacilitiesService, PublicHealthCheckService, PublicLeasingService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicScheduledSessionsService, PublicSessionsService, PublicSlotsService, PublicStripeWebhookService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantsService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportPatch, RecentOrderActivityReportPost, RecentOrderActivityReportService, ScheduleStatus, ScheduledSession, ScheduledSessionPage, ScheduledSessionPatch, ScheduledSessionPost, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSchedulePatch, ScheduledSessionSchedulePost, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, Session, SessionCreate, SessionGender, 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, SurveyCreate, SurveyPage, SurveyPatch, SurveyPost, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionPatch, SurveyQuestionPost, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveyReportExtended, SurveyReportExtendedPage, SurveyReportExtendedPatch, SurveyReportExtendedPost, SurveyReportExtendedService, SurveySubmissionModel, SurveyType, SurveysService, Tax, Tenant, TenantPage, TenantPatch, TenantPost, 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, VenueOpeningHours, VenuePage, VenuePatch, VenuePost, VenuesReport, VenuesReportPage, VenuesReportPatch, VenuesReportPost, VenuesReportService, VenuesService, WaitlistActivity, WaitlistActivityPage, WaitlistActivityPatch, WaitlistActivityPost, WaitlistActivityService, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityPatch, WaitlistOpportunityPost, WaitlistOpportunityService };
27902
+ export { Activity, ActivityService, ActivityType, AdvanceBooking, Amenity, AmenityService, ApiClient, ApiError, AppUserRole, ApplicationRole, AutoCompleteResponseModel, BadEnglandReportService, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CoursePage, CoursePatch, CoursePost, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionPatch, CourseSessionPost, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulePatch, CourseSessionSchedulePost, CourseSessionSchedulesService, CourseSessionsService, CoursesService, CreateOffer, CreateQuestion, CreateQuestionOption, CreateVenue, Customer, CustomerCancellationOption, CustomerPage, CustomerPatch, CustomerPost, CustomerType, CustomersService, DayOfWeek, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulePatch, EmailReminderSchedulePost, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingPatch, EmailSettingPost, EmailSettingsService, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualPatch, FacilityIndividualPost, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, FacilityPatch, FacilityPost, FilestackImageMetaResponseModel, FilestackService, 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, OpportunityType, Order, OrderItem, OrderItemPage, OrderItemPatch, OrderItemPost, OrderItemStatus, OrderItemsService, OrderPage, OrderPatch, OrderPost, OrderPostOrderItem, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrderTokenPatch, OrderTokenPost, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationPatch, OrgCourseUtilisationPost, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, Pagination, PatchSurveyQuestionOption, Payment, PaymentMethod, PaymentPage, PaymentPatch, PaymentPost, PaymentsService, Permission, PermissionPage, PermissionPatch, PermissionPost, PermissionsService, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammePatch, ProgrammePost, ProgrammesService, PublicBookingService, PublicCoursesService, PublicFacilitiesService, PublicHealthCheckService, PublicLeasingService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicScheduledSessionsService, PublicSessionsService, PublicSlotsService, PublicStripeWebhookService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantsService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportPatch, RecentOrderActivityReportPost, RecentOrderActivityReportService, ScheduleStatus, ScheduledSession, ScheduledSessionPage, ScheduledSessionPatch, ScheduledSessionPost, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSchedulePatch, ScheduledSessionSchedulePost, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, Session, SessionCreate, SessionGender, 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, SurveyCreate, SurveyPage, SurveyPatch, SurveyPost, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionPatch, SurveyQuestionPost, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveyReportExtended, SurveyReportExtendedPage, SurveyReportExtendedPatch, SurveyReportExtendedPost, SurveyReportExtendedService, SurveySubmissionModel, SurveyType, SurveysService, Tax, Tenant, TenantPage, TenantPatch, TenantPost, 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, 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
@@ -19517,6 +19517,22 @@ const request = (config, options, axiosClient = axios) => {
19517
19517
  constructor(httpRequest) {
19518
19518
  this.httpRequest = httpRequest;
19519
19519
  }
19520
+ /**
19521
+ * Gets the current tenant.
19522
+ * @returns Tenant Success
19523
+ * @throws ApiError
19524
+ */
19525
+ getTenantWebsiteSettings() {
19526
+ return this.httpRequest.request({
19527
+ method: "GET",
19528
+ url: "/api/tenant-website-settings/get-tenant-website-settings",
19529
+ errors: {
19530
+ 400: `Bad Request`,
19531
+ 422: `Client Error`,
19532
+ 500: `Server Error`
19533
+ }
19534
+ });
19535
+ }
19520
19536
  /**
19521
19537
  * Gets the resource by its Id.
19522
19538
  * @returns TenantWebsiteSetting Success
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "reach-api-sdk",
3
- "version": "1.0.25",
3
+ "version": "1.0.26",
4
4
  "description": "sdk for reach api",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -56696,6 +56696,61 @@ paths:
56696
56696
  text/json:
56697
56697
  schema:
56698
56698
  $ref: '#/components/schemas/ValidationResultModel'
56699
+ /api/tenant-website-settings/get-tenant-website-settings:
56700
+ get:
56701
+ tags:
56702
+ - TenantWebsiteSettings
56703
+ summary: Gets the current tenant.
56704
+ operationId: GetTenantWebsiteSettings
56705
+ responses:
56706
+ '200':
56707
+ description: Success
56708
+ content:
56709
+ text/plain:
56710
+ schema:
56711
+ $ref: '#/components/schemas/Tenant'
56712
+ application/json:
56713
+ schema:
56714
+ $ref: '#/components/schemas/Tenant'
56715
+ text/json:
56716
+ schema:
56717
+ $ref: '#/components/schemas/Tenant'
56718
+ '400':
56719
+ description: Bad Request
56720
+ content:
56721
+ text/plain:
56722
+ schema:
56723
+ $ref: '#/components/schemas/ReachError'
56724
+ application/json:
56725
+ schema:
56726
+ $ref: '#/components/schemas/ReachError'
56727
+ text/json:
56728
+ schema:
56729
+ $ref: '#/components/schemas/ReachError'
56730
+ '500':
56731
+ description: Server Error
56732
+ content:
56733
+ text/plain:
56734
+ schema:
56735
+ $ref: '#/components/schemas/ReachError'
56736
+ application/json:
56737
+ schema:
56738
+ $ref: '#/components/schemas/ReachError'
56739
+ text/json:
56740
+ schema:
56741
+ $ref: '#/components/schemas/ReachError'
56742
+ '422':
56743
+ description: Client Error
56744
+ content:
56745
+ text/plain:
56746
+ schema:
56747
+ $ref: '#/components/schemas/ValidationResultModel'
56748
+ application/json:
56749
+ schema:
56750
+ $ref: '#/components/schemas/ValidationResultModel'
56751
+ text/json:
56752
+ schema:
56753
+ $ref: '#/components/schemas/ValidationResultModel'
56699
56754
  '/api/tenant-website-settings/{id}':
56700
56755
  get:
56701
56756
  tags:
@@ -64978,7 +65033,7 @@ components:
64978
65033
  properties:
64979
65034
  clientIdentifier:
64980
65035
  type: string
64981
- description: 'Gets or sets the survey question client identifier, you can populate this with any unique value to help manage the questions array on the client, it is not required by the server.'
65036
+ description: 'Gets or sets the survey question client identifier, you can populate this with any unique value to help manage the questions array on the client, it is not required by the server and will be ignored.'
64982
65037
  nullable: true
64983
65038
  name:
64984
65039
  minLength: 1
@@ -65000,18 +65055,16 @@ components:
65000
65055
  additionalProperties: false
65001
65056
  description: Post model for survey questions.
65002
65057
  CreateQuestionOption:
65003
- required:
65004
- - name
65005
65058
  type: object
65006
65059
  properties:
65007
65060
  clientIdentifier:
65008
65061
  type: string
65009
- description: 'Gets or sets the survey question client identifier, you can populate this with any unique value to help manage the question options array on the client, it is not required by the server.'
65062
+ description: 'Gets or sets the survey question option client identifier, you can populate this with any unique value to help manage the question options array on the client, it is not required by the server and will be ignored.'
65010
65063
  nullable: true
65011
65064
  name:
65012
- minLength: 1
65013
65065
  type: string
65014
65066
  description: Gets or sets the survey question option name.
65067
+ nullable: true
65015
65068
  additionalProperties: false
65016
65069
  description: Post model for survey question options.
65017
65070
  CreateVenue:
@@ -67624,15 +67677,102 @@ components:
67624
67677
  description: Post model for order updates.
67625
67678
  OrderPost:
67626
67679
  required:
67680
+ - addressPostalcode
67681
+ - email
67682
+ - firstName
67683
+ - lastName
67684
+ - orderItems
67685
+ - payLater
67627
67686
  - tenantId
67687
+ - venueId
67628
67688
  type: object
67629
67689
  properties:
67630
67690
  tenantId:
67631
67691
  type: string
67632
67692
  description: Gets or sets the tenant Id.
67633
67693
  format: uuid
67694
+ venueId:
67695
+ type: string
67696
+ description: Gets or sets the venue Id.
67697
+ format: uuid
67698
+ firstName:
67699
+ minLength: 1
67700
+ type: string
67701
+ description: Gets or sets the first name.
67702
+ lastName:
67703
+ minLength: 1
67704
+ type: string
67705
+ description: Gets or sets the last name.
67706
+ email:
67707
+ minLength: 1
67708
+ type: string
67709
+ description: Gets or sets the email.
67710
+ phone:
67711
+ type: string
67712
+ description: Gets or sets the phone number.
67713
+ nullable: true
67714
+ addressPostalcode:
67715
+ minLength: 1
67716
+ type: string
67717
+ description: Gets or sets the orders postcode.
67718
+ isOndemand:
67719
+ type: boolean
67720
+ description: Gets or sets a value indicating whether the order and its associated slots have been created on demand within the order operation (e.g from a block booking).
67721
+ nullable: true
67722
+ allowOrderItemOverages:
67723
+ type: boolean
67724
+ description: Gets or sets a value indicating whether the order will ignore the maximum capacity of the ordered sessions.
67725
+ nullable: true
67726
+ privateNotes:
67727
+ type: string
67728
+ description: Gets or sets any private notes for the order.
67729
+ nullable: true
67730
+ paymentIntentClientSecret:
67731
+ type: string
67732
+ description: Gets or sets the orders stripe payment intent client secret.
67733
+ nullable: true
67734
+ payLater:
67735
+ type: boolean
67736
+ description: Gets or sets a value indicating whether the payment will be taken at a later date.
67737
+ default: false
67738
+ orderItems:
67739
+ type: array
67740
+ items:
67741
+ $ref: '#/components/schemas/OrderPostOrderItem'
67742
+ description: Gets or sets a value indicating whether the payment will be taken at a later date.
67634
67743
  additionalProperties: false
67635
67744
  description: Post model for order inserts.
67745
+ OrderPostOrderItem:
67746
+ required:
67747
+ - offerId
67748
+ type: object
67749
+ properties:
67750
+ slotId:
67751
+ type: string
67752
+ description: Gets or sets the slot id.
67753
+ format: uuid
67754
+ nullable: true
67755
+ scheduledSessionId:
67756
+ type: string
67757
+ description: Gets or sets the scheduled session id.
67758
+ format: uuid
67759
+ nullable: true
67760
+ courseId:
67761
+ type: string
67762
+ description: Gets or sets the course id.
67763
+ format: uuid
67764
+ nullable: true
67765
+ offerId:
67766
+ type: string
67767
+ description: Gets or sets the offer id.
67768
+ format: uuid
67769
+ quantity:
67770
+ type: integer
67771
+ description: Gets or sets the quantity of opportunities required on the order item.
67772
+ format: int32
67773
+ nullable: true
67774
+ additionalProperties: false
67775
+ description: Post model for session offers.
67636
67776
  OrderSource:
67637
67777
  enum:
67638
67778
  - Reach
@@ -68588,9 +68728,27 @@ components:
68588
68728
  description: The SlotSchedule active status.
68589
68729
  ScheduledSession:
68590
68730
  required:
68731
+ - actualRemainingUses
68732
+ - availabilityStatus
68733
+ - bookingStatus
68734
+ - capacity
68735
+ - capacityUnlimited
68591
68736
  - dateCreated
68592
68737
  - dateModified
68738
+ - durationMinutes
68739
+ - endDateTime
68740
+ - hasAvailability
68741
+ - isCollidable
68742
+ - isCreatedBySchedule
68743
+ - isDeletable
68744
+ - isExpired
68745
+ - isLeased
68593
68746
  - isLive
68747
+ - postCompletionEmailSent
68748
+ - remainingUses
68749
+ - sessionId
68750
+ - startDateTime
68751
+ - status
68594
68752
  - tenantId
68595
68753
  type: object
68596
68754
  properties:
@@ -68633,7 +68791,6 @@ components:
68633
68791
  type: integer
68634
68792
  description: 'Gets the slots remaining uses when also considering Order leases. This is computed at runtime since order leases expire silently, that is, there is no process that recalculates remaining uses when an Order lease expiry is reached.'
68635
68793
  format: int32
68636
- nullable: true
68637
68794
  readOnly: true
68638
68795
  isCollidable:
68639
68796
  type: boolean
@@ -68661,7 +68818,6 @@ components:
68661
68818
  type: string
68662
68819
  description: Gets or sets the session id.
68663
68820
  format: uuid
68664
- nullable: true
68665
68821
  status:
68666
68822
  $ref: '#/components/schemas/SlotStatus'
68667
68823
  leaseExpiry:
@@ -68684,12 +68840,10 @@ components:
68684
68840
  type: string
68685
68841
  description: Gets or sets the scheduled session start date time in UTC as is the applications required convention. (this datetime must always be UTC).
68686
68842
  format: date-time
68687
- nullable: true
68688
68843
  endDateTime:
68689
68844
  type: string
68690
68845
  description: Gets or sets the scheduled session end date time in UTC as is the applications required convention. (this datetime must always be UTC).
68691
68846
  format: date-time
68692
- nullable: true
68693
68847
  timePeriodLabel:
68694
68848
  type: string
68695
68849
  description: Gets the scheduled sessions period label.
@@ -68709,12 +68863,10 @@ components:
68709
68863
  type: integer
68710
68864
  description: Gets or sets the scheduled session remaining uses. Defaults to 1.
68711
68865
  format: int32
68712
- nullable: true
68713
68866
  capacity:
68714
68867
  type: integer
68715
68868
  description: Gets or sets the scheduled sessions capacity.
68716
68869
  format: int32
68717
- nullable: true
68718
68870
  postCompletionEmailSent:
68719
68871
  type: boolean
68720
68872
  description: Gets or sets a value indicating whether the post activity completion email has been sent.
@@ -68722,7 +68874,6 @@ components:
68722
68874
  capacityUnlimited:
68723
68875
  type: boolean
68724
68876
  description: Gets a value indicating whether this scheduled session has unlimited capacity.
68725
- nullable: true
68726
68877
  readOnly: true
68727
68878
  session:
68728
68879
  $ref: '#/components/schemas/Session'
package/src/index.ts CHANGED
@@ -116,6 +116,7 @@ export { OrderItemStatus } from './models/OrderItemStatus';
116
116
  export type { OrderPage } from './models/OrderPage';
117
117
  export type { OrderPatch } from './models/OrderPatch';
118
118
  export type { OrderPost } from './models/OrderPost';
119
+ export type { OrderPostOrderItem } from './models/OrderPostOrderItem';
119
120
  export { OrderSource } from './models/OrderSource';
120
121
  export { OrderStage } from './models/OrderStage';
121
122
  export type { OrderToken } from './models/OrderToken';
@@ -11,7 +11,7 @@ import type { SurveyQuestionType } from './SurveyQuestionType';
11
11
  */
12
12
  export type CreateQuestion = {
13
13
  /**
14
- * Gets or sets the survey question client identifier, you can populate this with any unique value to help manage the questions array on the client, it is not required by the server.
14
+ * Gets or sets the survey question client identifier, you can populate this with any unique value to help manage the questions array on the client, it is not required by the server and will be ignored.
15
15
  */
16
16
  clientIdentifier?: string | null;
17
17
  /**
@@ -8,11 +8,11 @@
8
8
  */
9
9
  export type CreateQuestionOption = {
10
10
  /**
11
- * Gets or sets the survey question client identifier, you can populate this with any unique value to help manage the question options array on the client, it is not required by the server.
11
+ * Gets or sets the survey question option client identifier, you can populate this with any unique value to help manage the question options array on the client, it is not required by the server and will be ignored.
12
12
  */
13
13
  clientIdentifier?: string | null;
14
14
  /**
15
15
  * Gets or sets the survey question option name.
16
16
  */
17
- name: string;
17
+ name?: string | null;
18
18
  };
@@ -3,6 +3,8 @@
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
5
 
6
+ import type { OrderPostOrderItem } from './OrderPostOrderItem';
7
+
6
8
  /**
7
9
  * Post model for order inserts.
8
10
  */
@@ -11,4 +13,52 @@ export type OrderPost = {
11
13
  * Gets or sets the tenant Id.
12
14
  */
13
15
  tenantId: string;
16
+ /**
17
+ * Gets or sets the venue Id.
18
+ */
19
+ venueId: string;
20
+ /**
21
+ * Gets or sets the first name.
22
+ */
23
+ firstName: string;
24
+ /**
25
+ * Gets or sets the last name.
26
+ */
27
+ lastName: string;
28
+ /**
29
+ * Gets or sets the email.
30
+ */
31
+ email: string;
32
+ /**
33
+ * Gets or sets the phone number.
34
+ */
35
+ phone?: string | null;
36
+ /**
37
+ * Gets or sets the orders postcode.
38
+ */
39
+ addressPostalcode: string;
40
+ /**
41
+ * Gets or sets a value indicating whether the order and its associated slots have been created on demand within the order operation (e.g from a block booking).
42
+ */
43
+ isOndemand?: boolean | null;
44
+ /**
45
+ * Gets or sets a value indicating whether the order will ignore the maximum capacity of the ordered sessions.
46
+ */
47
+ allowOrderItemOverages?: boolean | null;
48
+ /**
49
+ * Gets or sets any private notes for the order.
50
+ */
51
+ privateNotes?: string | null;
52
+ /**
53
+ * Gets or sets the orders stripe payment intent client secret.
54
+ */
55
+ paymentIntentClientSecret?: string | null;
56
+ /**
57
+ * Gets or sets a value indicating whether the payment will be taken at a later date.
58
+ */
59
+ payLater: boolean;
60
+ /**
61
+ * Gets or sets a value indicating whether the payment will be taken at a later date.
62
+ */
63
+ orderItems: Array<OrderPostOrderItem>;
14
64
  };
@@ -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 session offers.
8
+ */
9
+ export type OrderPostOrderItem = {
10
+ /**
11
+ * Gets or sets the slot id.
12
+ */
13
+ slotId?: string | null;
14
+ /**
15
+ * Gets or sets the scheduled session id.
16
+ */
17
+ scheduledSessionId?: string | null;
18
+ /**
19
+ * Gets or sets the course id.
20
+ */
21
+ courseId?: string | null;
22
+ /**
23
+ * Gets or sets the offer id.
24
+ */
25
+ offerId: string;
26
+ /**
27
+ * Gets or sets the quantity of opportunities required on the order item.
28
+ */
29
+ quantity?: number | null;
30
+ };
@@ -43,42 +43,42 @@ export type ScheduledSession = {
43
43
  /**
44
44
  * Gets a value indicating whether the slot is leased waiting confirmation to be made bookable by the Reach tenant. This status does not refer to a booking lease!.
45
45
  */
46
- readonly isLeased?: boolean;
46
+ readonly isLeased: boolean;
47
47
  /**
48
48
  * Gets a value indicating whether the slot has availability also considering leases.
49
49
  */
50
- readonly hasAvailability?: boolean;
50
+ readonly hasAvailability: boolean;
51
51
  /**
52
52
  * Gets the slots remaining uses when also considering Order leases. This is computed at runtime since order leases expire silently, that is, there is no process that recalculates remaining uses when an Order lease expiry is reached.
53
53
  */
54
- readonly actualRemainingUses?: number | null;
54
+ readonly actualRemainingUses: number;
55
55
  /**
56
56
  * Gets a value indicating whether the scheduled session is collidable.
57
57
  */
58
- readonly isCollidable?: boolean;
58
+ readonly isCollidable: boolean;
59
59
  /**
60
60
  * Gets a value indicating whether the scheduled session is expired due to passing the end date time.
61
61
  */
62
- readonly isExpired?: boolean;
62
+ readonly isExpired: boolean;
63
63
  /**
64
64
  * Gets a value indicating whether the scheduled session is booked.
65
65
  */
66
- readonly isCreatedBySchedule?: boolean;
66
+ readonly isCreatedBySchedule: boolean;
67
67
  /**
68
68
  * Gets a value indicating whether the scheduled session is deletable.
69
69
  */
70
- readonly isDeletable?: boolean;
71
- availabilityStatus?: SlotAvailabilityStatus;
70
+ readonly isDeletable: boolean;
71
+ availabilityStatus: SlotAvailabilityStatus;
72
72
  /**
73
73
  * Gets or sets the session id.
74
74
  */
75
- sessionId?: string | null;
76
- status?: SlotStatus;
75
+ sessionId: string;
76
+ status: SlotStatus;
77
77
  /**
78
78
  * Gets or sets the scheduled session creation lease expiry. Preventing other scheduled sessions from overwriting until the lease expires.
79
79
  */
80
80
  leaseExpiry?: string | null;
81
- bookingStatus?: BookingStatus;
81
+ bookingStatus: BookingStatus;
82
82
  /**
83
83
  * Gets or sets the scheduled session on confirmed conflicted description.
84
84
  */
@@ -90,11 +90,11 @@ export type ScheduledSession = {
90
90
  /**
91
91
  * Gets or sets the scheduled session start date time in UTC as is the applications required convention. (this datetime must always be UTC).
92
92
  */
93
- startDateTime?: string | null;
93
+ startDateTime: string;
94
94
  /**
95
95
  * Gets or sets the scheduled session end date time in UTC as is the applications required convention. (this datetime must always be UTC).
96
96
  */
97
- endDateTime?: string | null;
97
+ endDateTime: string;
98
98
  /**
99
99
  * Gets the scheduled sessions period label.
100
100
  */
@@ -106,23 +106,23 @@ export type ScheduledSession = {
106
106
  /**
107
107
  * Gets or sets the scheduled session duration.
108
108
  */
109
- durationMinutes?: number;
109
+ durationMinutes: number;
110
110
  /**
111
111
  * Gets or sets the scheduled session remaining uses. Defaults to 1.
112
112
  */
113
- remainingUses?: number | null;
113
+ remainingUses: number;
114
114
  /**
115
115
  * Gets or sets the scheduled sessions capacity.
116
116
  */
117
- capacity?: number | null;
117
+ capacity: number;
118
118
  /**
119
119
  * Gets or sets a value indicating whether the post activity completion email has been sent.
120
120
  */
121
- postCompletionEmailSent?: boolean;
121
+ postCompletionEmailSent: boolean;
122
122
  /**
123
123
  * Gets a value indicating whether this scheduled session has unlimited capacity.
124
124
  */
125
- readonly capacityUnlimited?: boolean | null;
125
+ readonly capacityUnlimited: boolean;
126
126
  session?: Session;
127
127
  scheduledSessionSchedule?: ScheduledSessionSchedule;
128
128
  /**
@@ -3,6 +3,7 @@
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
5
  import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
6
+ import type { Tenant } from '../models/Tenant';
6
7
  import type { TenantWebsiteSetting } from '../models/TenantWebsiteSetting';
7
8
  import type { TenantWebsiteSettingPage } from '../models/TenantWebsiteSettingPage';
8
9
  import type { TenantWebsiteSettingPatch } from '../models/TenantWebsiteSettingPatch';
@@ -14,6 +15,23 @@ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
14
15
  export class TenantWebsiteSettingsService {
15
16
  constructor(public readonly httpRequest: BaseHttpRequest) {}
16
17
 
18
+ /**
19
+ * Gets the current tenant.
20
+ * @returns Tenant Success
21
+ * @throws ApiError
22
+ */
23
+ public getTenantWebsiteSettings(): CancelablePromise<Tenant> {
24
+ return this.httpRequest.request({
25
+ method: 'GET',
26
+ url: '/api/tenant-website-settings/get-tenant-website-settings',
27
+ errors: {
28
+ 400: `Bad Request`,
29
+ 422: `Client Error`,
30
+ 500: `Server Error`,
31
+ },
32
+ });
33
+ }
34
+
17
35
  /**
18
36
  * Gets the resource by its Id.
19
37
  * @returns TenantWebsiteSetting Success