reach-api-sdk 1.0.217 → 1.0.218

package/src/index.ts

@@ -327,6 +327,10 @@ export type { ScheduledSessionSchedulePost } from './models/ScheduledSessionSche
 export { ScheduledSessionSearchSortBy } from './models/ScheduledSessionSearchSortBy';
 export { ScheduleStatus } from './models/ScheduleStatus';
 export { SearchSortOrderDirection } from './models/SearchSortOrderDirection';
+export type { SellableItem } from './models/SellableItem';
+export type { SellableItemPage } from './models/SellableItemPage';
+export type { SellableItemPatch } from './models/SellableItemPatch';
+export type { SellableItemPost } from './models/SellableItemPost';
 export type { Session } from './models/Session';
 export type { SessionCreate } from './models/SessionCreate';
 export type { SessionPage } from './models/SessionPage';
@@ -598,6 +602,7 @@ export { PublicOrderTokensService } from './services/PublicOrderTokensService';
 export { PublicProgrammesService } from './services/PublicProgrammesService';
 export { PublicProvidersService } from './services/PublicProvidersService';
 export { PublicScheduledSessionsService } from './services/PublicScheduledSessionsService';
+export { PublicSellableItemsService } from './services/PublicSellableItemsService';
 export { PublicSessionsService } from './services/PublicSessionsService';
 export { PublicSlotsService } from './services/PublicSlotsService';
 export { PublicStorefrontStaffPreviewService } from './services/PublicStorefrontStaffPreviewService';
@@ -615,6 +620,7 @@ export { RegisterReportService } from './services/RegisterReportService';
 export { RescheduleLogService } from './services/RescheduleLogService';
 export { ScheduledSessionsService } from './services/ScheduledSessionsService';
 export { ScheduledSessionsSchedulesService } from './services/ScheduledSessionsSchedulesService';
+export { SellableItemsService } from './services/SellableItemsService';
 export { SessionsService } from './services/SessionsService';
 export { SlotOffersService } from './services/SlotOffersService';
 export { SlotsService } from './services/SlotsService';

package/src/models/ActivityType.ts

@@ -10,4 +10,5 @@ export enum ActivityType {
   FACILITY = 'Facility',
   SESSION = 'Session',
   COURSE = 'Course',
+  SELLABLE_ITEM = 'SellableItem',
 }

package/src/models/DealActivity.ts

@@ -45,5 +45,9 @@ export type DealActivity = {
    * Gets or sets the session id.
    */
   sessionId?: string | null;
+  /**
+   * Gets or sets the sellable item id.
+   */
+  sellableItemId?: string | null;
   deal?: Deal;
 };

package/src/models/DealActivityPost.ts

@@ -23,4 +23,8 @@ export type DealActivityPost = {
    * Gets or sets the session id.
    */
   sessionId?: string | null;
+  /**
+   * Gets or sets the sellable item id.
+   */
+  sellableItemId?: string | null;
 };

package/src/models/EmailSetting.ts

@@ -51,6 +51,10 @@ export type EmailSetting = {
    * Gets or sets the course Id.
    */
   courseId?: string | null;
+  /**
+   * Gets or sets the sellable item Id.
+   */
+  sellableItemId?: string | null;
   /**
    * Gets or sets the order confirmation text.
    */

package/src/models/GenericActivity.ts

@@ -179,4 +179,8 @@ export type GenericActivity = {
    * Gets or sets the courses sessions (only applicable to courses).
    */
   sessions?: Array<CourseSession> | null;
+  /**
+   * Gets or sets remaining inventory for Reach.Models.ActivityType.SellableItem (populated on list/detail when applicable).
+   */
+  stockQuantity?: number | null;
 };

package/src/models/Image.ts

@@ -52,6 +52,10 @@ export type Image = {
    * Gets or sets the images course id.
    */
   courseId?: string | null;
+  /**
+   * Gets or sets the sellable item id.
+   */
+  sellableItemId?: string | null;
   /**
    * Gets or sets the images programme id.
    */

package/src/models/Offer.ts

@@ -53,6 +53,10 @@ export type Offer = {
    * Gets or sets the course id.
    */
   courseId?: string | null;
+  /**
+   * Gets or sets the sellable item id.
+   */
+  sellableItemId?: string | null;
   /**
    * Gets or sets the survey id.
    */

package/src/models/OfferPatch.ts

@@ -31,6 +31,10 @@ export type OfferPatch = {
    * Gets or sets the course id.
    */
   courseId?: string | null;
+  /**
+   * Gets or sets the sellable item id.
+   */
+  sellableItemId?: string | null;
   /**
    * Gets or sets the survey id.
    */

package/src/models/OfferPost.ts

@@ -27,6 +27,10 @@ export type OfferPost = {
    * Gets or sets the course id.
    */
   courseId?: string | null;
+  /**
+   * Gets or sets the sellable item id.
+   */
+  sellableItemId?: string | null;
   /**
    * Gets or sets the survey id.
    */

package/src/models/OpportunityType.ts

@@ -10,4 +10,5 @@ export enum OpportunityType {
   SLOT = 'Slot',
   SCHEDULED_SESSION = 'ScheduledSession',
   COURSE = 'Course',
+  SELLABLE_ITEM = 'SellableItem',
 }

package/src/models/OrderItem.ts

@@ -12,6 +12,7 @@ import type { Order } from './Order';
 import type { OrderItemDeal } from './OrderItemDeal';
 import type { OrderItemStatus } from './OrderItemStatus';
 import type { ScheduledSession } from './ScheduledSession';
+import type { SellableItem } from './SellableItem';
 import type { Slot } from './Slot';
 
 /**
@@ -58,6 +59,10 @@ export type OrderItem = {
    * Gets or sets the course id.
    */
   courseId?: string | null;
+  /**
+   * Gets or sets the sellable item id.
+   */
+  sellableItemId?: string | null;
   /**
    * Gets or sets the offer id.
    */
@@ -111,6 +116,7 @@ export type OrderItem = {
   slot?: Slot;
   scheduledSession?: ScheduledSession;
   course?: Course;
+  sellableItem?: SellableItem;
   offer?: Offer;
   /**
    * Gets or sets the order item deals.

package/src/models/OrderPatchItem.ts

@@ -23,6 +23,10 @@ export type OrderPatchItem = {
    * Gets or sets the course id.
    */
   courseId?: string | null;
+  /**
+   * Gets or sets the sellable item id.
+   */
+  sellableItemId?: string | null;
   /**
    * Gets or sets the offer id.
    */

package/src/models/OrderPostItem.ts

@@ -19,6 +19,10 @@ export type OrderPostItem = {
    * Gets or sets the course id.
    */
   courseId?: string | null;
+  /**
+   * Gets or sets the sellable item id.
+   */
+  sellableItemId?: string | null;
   /**
    * Gets or sets the offer id.
    */

package/src/models/SellableItem.ts

@@ -0,0 +1,194 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { Activity } from './Activity';
+import type { CancellationPolicy } from './CancellationPolicy';
+import type { CheckoutPlatform } from './CheckoutPlatform';
+import type { Deal } from './Deal';
+import type { Gender } from './Gender';
+import type { Image } from './Image';
+import type { Offer } from './Offer';
+import type { PaymentPolicy } from './PaymentPolicy';
+import type { Venue } from './Venue';
+
+/**
+ * A venue-scoped product with inventory (no scheduled session or course).
+ */
+export type SellableItem = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive: boolean;
+  /**
+   * Gets or sets the provider id.
+   */
+  providerId?: string | null;
+  /**
+   * Gets or sets the venue id.
+   */
+  venueId?: string | null;
+  /**
+   * Gets or sets the activity category id.
+   */
+  activityId?: number | null;
+  /**
+   * Gets or sets the name.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets the description.
+   */
+  description?: string | null;
+  /**
+   * Gets or sets the image url.
+   */
+  imageUrl?: string | null;
+  /**
+   * Gets or sets a value indicating whether the item is bookable on the web.
+   */
+  online?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the item is archived.
+   */
+  archived?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the item is deleted.
+   */
+  deleted?: boolean | null;
+  /**
+   * Gets or sets remaining stock (decremented when orders are booked).
+   */
+  stockQuantity?: number;
+  /**
+   * Gets or sets a value indicating whether the item is featured on the storefront.
+   */
+  featured?: boolean;
+  /**
+   * Gets or sets a value indicating whether the item is private.
+   */
+  private?: boolean;
+  /**
+   * Gets or sets the checkout survey id.
+   */
+  surveyId?: string | null;
+  /**
+   * Gets or sets the post-completion survey id.
+   */
+  postCompletionSurveyId?: string | null;
+  /**
+   * Gets or sets the cancellation policy id.
+   */
+  cancellationPolicyId?: string;
+  /**
+   * Gets or sets the payment policy id.
+   */
+  paymentPolicyId?: string;
+  gender?: Gender;
+  /**
+   * Gets or sets the min age.
+   */
+  minAge?: number | null;
+  /**
+   * Gets or sets the max age.
+   */
+  maxAge?: number | null;
+  /**
+   * Gets or sets a value indicating whether there is no age restriction.
+   */
+  noAgeRestriction?: boolean;
+  /**
+   * Gets or sets additional support options.
+   */
+  additionalSupport?: Array<string> | null;
+  /**
+   * Gets or sets the contact name.
+   */
+  contactName?: string | null;
+  /**
+   * Gets or sets the contact phone.
+   */
+  contactPhone?: string | null;
+  /**
+   * Gets or sets the contact email.
+   */
+  contactEmail?: string | null;
+  /**
+   * Gets or sets the admin contact name.
+   */
+  adminContactName?: string | null;
+  /**
+   * Gets or sets the admin contact phone.
+   */
+  adminContactPhone?: string | null;
+  /**
+   * Gets or sets the admin contact email.
+   */
+  adminContactEmail?: string | null;
+  /**
+   * Gets or sets a value indicating whether to send reminder emails.
+   */
+  sendReminder?: boolean | null;
+  /**
+   * Gets or sets the reminder hours before start.
+   */
+  reminderHoursBeforeStart?: number | null;
+  checkoutPlatform?: CheckoutPlatform;
+  /**
+   * Gets or sets the booking link override when checkout is external.
+   */
+  bookingLinkOverride?: string | null;
+  /**
+   * Gets or sets a value indicating whether pre-registration is enabled.
+   */
+  preRegistrationEnabled?: boolean | null;
+  /**
+   * Gets or sets when pre-registration opens.
+   */
+  preRegistrationOpensAt?: string | null;
+  /**
+   * Gets or sets when pre-registration closes.
+   */
+  preRegistrationClosesAt?: string | null;
+  /**
+   * Gets or sets the pre-registration storefront message.
+   */
+  preRegistrationMessage?: string | null;
+  venue?: Venue;
+  cancellationPolicy?: CancellationPolicy;
+  paymentPolicy?: PaymentPolicy;
+  activity?: Activity;
+  /**
+   * Gets or sets offers for this item.
+   */
+  offers?: Array<Offer> | null;
+  /**
+   * Gets or sets images.
+   */
+  images?: Array<Image> | null;
+  /**
+   * Gets or sets deals applicable to this item.
+   */
+  deals?: Array<Deal> | null;
+};

package/src/models/SellableItemPage.ts

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

package/src/models/SellableItemPatch.ts

@@ -0,0 +1,150 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CheckoutPlatform } from './CheckoutPlatform';
+import type { Gender } from './Gender';
+import type { UpdateEmailSettings } from './UpdateEmailSettings';
+import type { UpdateOffer } from './UpdateOffer';
+
+/**
+ * Patch model for sellable item updates.
+ */
+export type SellableItemPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  /**
+   * Gets or sets the venue id.
+   */
+  venueId?: string | null;
+  /**
+   * Gets or sets the activity category id.
+   */
+  activityId?: number | null;
+  /**
+   * Gets or sets the name.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets the description.
+   */
+  description?: string | null;
+  /**
+   * Gets or sets the image url.
+   */
+  imageUrl?: string | null;
+  /**
+   * Gets or sets a value indicating whether the item is bookable on the web.
+   */
+  online?: boolean | null;
+  /**
+   * Gets or sets remaining stock.
+   */
+  stockQuantity?: number;
+  /**
+   * Gets or sets a value indicating whether the item is featured.
+   */
+  featured?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the item is private.
+   */
+  private?: boolean | null;
+  /**
+   * Gets or sets the checkout survey id.
+   */
+  surveyId?: string | null;
+  /**
+   * Gets or sets the post-completion survey id.
+   */
+  postCompletionSurveyId?: string | null;
+  /**
+   * Gets or sets the cancellation policy id.
+   */
+  cancellationPolicyId?: string | null;
+  /**
+   * Gets or sets the payment policy id.
+   */
+  paymentPolicyId?: string | null;
+  gender?: Gender;
+  /**
+   * Gets or sets the min age.
+   */
+  minAge?: number | null;
+  /**
+   * Gets or sets the max age.
+   */
+  maxAge?: number | null;
+  /**
+   * Gets or sets a value indicating whether there is no age restriction.
+   */
+  noAgeRestriction?: boolean | null;
+  /**
+   * Gets or sets additional support options.
+   */
+  additionalSupport?: Array<string> | null;
+  /**
+   * Gets or sets the contact name.
+   */
+  contactName?: string | null;
+  /**
+   * Gets or sets the contact phone.
+   */
+  contactPhone?: string | null;
+  /**
+   * Gets or sets the contact email.
+   */
+  contactEmail?: string | null;
+  /**
+   * Gets or sets the admin contact name.
+   */
+  adminContactName?: string | null;
+  /**
+   * Gets or sets the admin contact phone.
+   */
+  adminContactPhone?: string | null;
+  /**
+   * Gets or sets the admin contact email.
+   */
+  adminContactEmail?: string | null;
+  /**
+   * Gets or sets a value indicating whether to send reminder emails.
+   */
+  sendReminder?: boolean | null;
+  /**
+   * Gets or sets the reminder hours before start.
+   */
+  reminderHoursBeforeStart?: number | null;
+  checkoutPlatform?: CheckoutPlatform;
+  /**
+   * Gets or sets the booking link override.
+   */
+  bookingLinkOverride?: string | null;
+  /**
+   * Gets or sets a value indicating whether pre-registration is enabled.
+   */
+  preRegistrationEnabled?: boolean | null;
+  /**
+   * Gets or sets when pre-registration opens.
+   */
+  preRegistrationOpensAt?: string | null;
+  /**
+   * Gets or sets when pre-registration closes.
+   */
+  preRegistrationClosesAt?: string | null;
+  /**
+   * Gets or sets the pre-registration message.
+   */
+  preRegistrationMessage?: string | null;
+  emailSettings?: UpdateEmailSettings;
+  /**
+   * Gets or sets ticket types / offers for this item.
+   */
+  offers?: Array<UpdateOffer> | null;
+};

package/src/models/SellableItemPost.ts

@@ -0,0 +1,145 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CheckoutPlatform } from './CheckoutPlatform';
+import type { Gender } from './Gender';
+import type { UpdateEmailSettings } from './UpdateEmailSettings';
+
+/**
+ * Post model for sellable item inserts.
+ */
+export type SellableItemPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the provider id.
+   */
+  providerId?: string | null;
+  /**
+   * Gets or sets the venue id.
+   */
+  venueId?: string | null;
+  /**
+   * Gets or sets the activity category id.
+   */
+  activityId?: number | null;
+  /**
+   * Gets or sets the name.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets the description.
+   */
+  description?: string | null;
+  /**
+   * Gets or sets the image url.
+   */
+  imageUrl?: string | null;
+  /**
+   * Gets or sets a value indicating whether the item is bookable on the web.
+   */
+  online?: boolean | null;
+  /**
+   * Gets or sets remaining stock.
+   */
+  stockQuantity?: number;
+  /**
+   * Gets or sets a value indicating whether the item is featured.
+   */
+  featured?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the item is private.
+   */
+  private?: boolean | null;
+  /**
+   * Gets or sets the checkout survey id.
+   */
+  surveyId?: string | null;
+  /**
+   * Gets or sets the post-completion survey id.
+   */
+  postCompletionSurveyId?: string | null;
+  /**
+   * Gets or sets the cancellation policy id.
+   */
+  cancellationPolicyId?: string | null;
+  /**
+   * Gets or sets the payment policy id.
+   */
+  paymentPolicyId?: string | null;
+  gender?: Gender;
+  /**
+   * Gets or sets the min age.
+   */
+  minAge?: number | null;
+  /**
+   * Gets or sets the max age.
+   */
+  maxAge?: number | null;
+  /**
+   * Gets or sets a value indicating whether there is no age restriction.
+   */
+  noAgeRestriction?: boolean | null;
+  /**
+   * Gets or sets additional support options.
+   */
+  additionalSupport?: Array<string> | null;
+  /**
+   * Gets or sets the contact name.
+   */
+  contactName?: string | null;
+  /**
+   * Gets or sets the contact phone.
+   */
+  contactPhone?: string | null;
+  /**
+   * Gets or sets the contact email.
+   */
+  contactEmail?: string | null;
+  /**
+   * Gets or sets the admin contact name.
+   */
+  adminContactName?: string | null;
+  /**
+   * Gets or sets the admin contact phone.
+   */
+  adminContactPhone?: string | null;
+  /**
+   * Gets or sets the admin contact email.
+   */
+  adminContactEmail?: string | null;
+  /**
+   * Gets or sets a value indicating whether to send reminder emails.
+   */
+  sendReminder?: boolean | null;
+  /**
+   * Gets or sets the reminder hours before start.
+   */
+  reminderHoursBeforeStart?: number | null;
+  checkoutPlatform?: CheckoutPlatform;
+  /**
+   * Gets or sets the booking link override.
+   */
+  bookingLinkOverride?: string | null;
+  /**
+   * Gets or sets a value indicating whether pre-registration is enabled.
+   */
+  preRegistrationEnabled?: boolean | null;
+  /**
+   * Gets or sets when pre-registration opens.
+   */
+  preRegistrationOpensAt?: string | null;
+  /**
+   * Gets or sets when pre-registration closes.
+   */
+  preRegistrationClosesAt?: string | null;
+  /**
+   * Gets or sets the pre-registration message.
+   */
+  preRegistrationMessage?: string | null;
+  emailSettings?: UpdateEmailSettings;
+};