reach-api-sdk 1.0.217 → 1.0.219

package/src/models/IntegrationCodelocksSettingsCreate.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Create/update payload for Codelocks integration settings (upsert from partner settings UI).
+ */
+export type IntegrationCodelocksSettingsCreate = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets a value indicating whether the integration is enabled.
+   */
+  enabled: boolean;
+};

package/src/models/IntegrationCodelocksSettingsPage.ts

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

package/src/models/IntegrationCodelocksSettingsPatch.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for Codelocks integration settings updates.
+ */
+export type IntegrationCodelocksSettingsPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  /**
+   * Gets or sets a value indicating whether the integration is enabled.
+   */
+  enabled?: boolean | null;
+};

package/src/models/IntegrationCodelocksSettingsPost.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for Codelocks integration settings inserts.
+ */
+export type IntegrationCodelocksSettingsPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets a value indicating whether the integration is enabled.
+   */
+  enabled?: boolean | null;
+};

package/src/models/IntegrationQueue.ts

@@ -54,4 +54,8 @@ export type IntegrationQueue = {
    * Gets or sets the last error message if any.
    */
   lastError?: string | null;
+  /**
+   * Gets or sets the earliest UTC instant when this queue item may be processed (e.g. NetCode T−60m).
+   */
+  processAfterUtc?: string | null;
 };

package/src/models/IntegrationType.ts

@@ -8,4 +8,5 @@
  */
 export enum IntegrationType {
   DOTDIGITAL_UPSERT_CONTACT = 'DotdigitalUpsertContact',
+  CODELOCKS_GENERATE_NET_CODE = 'CodelocksGenerateNetCode',
 }

package/src/models/NotificationType.ts

@@ -21,4 +21,5 @@ export enum NotificationType {
   NEW_ACTIVITY = 'NewActivity',
   PAYMENT_RECIEVED = 'PaymentRecieved',
   POST_COMPLETION_SURVEY_COMPLETED = 'PostCompletionSurveyCompleted',
+  CODELOCKS_ACCESS_CODE_READY = 'CodelocksAccessCodeReady',
 }

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/Order.ts

@@ -165,7 +165,7 @@ export type Order = {
   /**
    * Gets or sets the last name.
    */
-  lastName?: string | null;
+  lastName: string;
   /**
    * Gets the attendees abbreviated name.
    */
@@ -177,11 +177,11 @@ export type Order = {
   /**
    * Gets or sets the email.
    */
-  email?: string | null;
+  email: string;
   /**
    * Gets or sets the phone number.
    */
-  phone?: string | null;
+  phone: string;
   /**
    * Gets or sets the orders street address.
    */

package/src/models/OrderItem.ts

@@ -9,9 +9,11 @@ import type { IOpportunity } from './IOpportunity';
 import type { Offer } from './Offer';
 import type { OpportunityType } from './OpportunityType';
 import type { Order } from './Order';
+import type { OrderItemCodelocksAccess } from './OrderItemCodelocksAccess';
 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';
 
 /**
@@ -45,7 +47,7 @@ export type OrderItem = {
   /**
    * Gets or sets the order id.
    */
-  orderId?: string | null;
+  orderId: string;
   /**
    * Gets or sets the slot id.
    */
@@ -58,10 +60,14 @@ 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.
    */
-  offerId?: string | null;
+  offerId: string;
   /**
    * Gets or sets the payment policy id.
    */
@@ -77,7 +83,7 @@ export type OrderItem = {
   /**
    * Gets or sets the quantity of opportunities required on the order item.
    */
-  quantity?: number | null;
+  quantity: number;
   status?: OrderItemStatus;
   /**
    * Gets or sets a value indicating whether the order item has been refunded.
@@ -111,6 +117,7 @@ export type OrderItem = {
   slot?: Slot;
   scheduledSession?: ScheduledSession;
   course?: Course;
+  sellableItem?: SellableItem;
   offer?: Offer;
   /**
    * Gets or sets the order item deals.
@@ -127,6 +134,7 @@ export type OrderItem = {
    * Gets or sets a value indicating whether the order item is rescheduleable.
    */
   rescheduleable?: boolean | null;
+  codelocksAccess?: OrderItemCodelocksAccess;
   /**
    * Gets or sets the unit price before discount.
    */

package/src/models/OrderItemCodelocksAccess.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Generated Codelocks access for a single order line (customer portal JSON only; not persisted on Reach.Models.OrderItem).
+ */
+export type OrderItemCodelocksAccess = {
+  /**
+   * Gets or sets the access code (NetCode) shown to the customer.
+   */
+  accessCode?: string | null;
+};

package/src/models/OrderItemReport.ts

@@ -91,9 +91,33 @@ export type OrderItemReport = {
    */
   offerName?: string | null;
   /**
-   * Gets or sets the order item value.
+   * Gets or sets the unit list price before discount (per unit).
+   */
+  unitPriceBeforeDiscount?: number | null;
+  /**
+   * Gets or sets the unit price after discount (per unit).
+   */
+  unitPriceAfterDiscount?: number | null;
+  /**
+   * Gets or sets the order item list line total (offer unit price × quantity).
    */
   orderItemValue?: number;
+  /**
+   * Gets or sets the line total after discount (`effective_item_price`).
+   */
+  orderItemValueAfterDiscount?: number | null;
+  /**
+   * Gets or sets applied deal names (semicolon-separated when multiple).
+   */
+  dealName?: string | null;
+  /**
+   * Gets or sets discount codes from applied deals (semicolon-separated when multiple).
+   */
+  discountCode?: string | null;
+  /**
+   * Gets or sets total deal discount value allocated to this line.
+   */
+  dealValue?: number | null;
   /**
    * Gets or sets the currency.
    */

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;
+};