reach-api-sdk 1.0.217 → 1.0.219

package/src/index.ts

@@ -10,6 +10,10 @@ export { CancelablePromise, CancelError } from './core/CancelablePromise';
 export { OpenAPI } from './core/OpenAPI';
 export type { OpenAPIConfig } from './core/OpenAPI';
 
+export type { AccessCredential } from './models/AccessCredential';
+export type { AccessCredentialPage } from './models/AccessCredentialPage';
+export type { AccessCredentialPatch } from './models/AccessCredentialPatch';
+export type { AccessCredentialPost } from './models/AccessCredentialPost';
 export type { Activity } from './models/Activity';
 export type { ActivityFacet } from './models/ActivityFacet';
 export type { ActivityPerformance } from './models/ActivityPerformance';
@@ -41,6 +45,10 @@ export type { CancellationPolicyPatch } from './models/CancellationPolicyPatch';
 export type { CancellationPolicyPost } from './models/CancellationPolicyPost';
 export { CheckoutPlatform } from './models/CheckoutPlatform';
 export type { ChoiceMessage } from './models/ChoiceMessage';
+export type { CodelocksLock } from './models/CodelocksLock';
+export type { CodelocksLockPage } from './models/CodelocksLockPage';
+export type { CodelocksLockPatch } from './models/CodelocksLockPatch';
+export type { CodelocksLockPost } from './models/CodelocksLockPost';
 export type { CompletionChoice } from './models/CompletionChoice';
 export { ContactOnConfirmation } from './models/ContactOnConfirmation';
 export type { Country } from './models/Country';
@@ -138,6 +146,8 @@ export { FacilityIndividualsType } from './models/FacilityIndividualsType';
 export type { FacilityPage } from './models/FacilityPage';
 export type { FacilityPatch } from './models/FacilityPatch';
 export type { FacilityPost } from './models/FacilityPost';
+export type { FeatureAnnouncementDismissPost } from './models/FeatureAnnouncementDismissPost';
+export type { FeatureAnnouncementForUserDto } from './models/FeatureAnnouncementForUserDto';
 export { FieldPermission } from './models/FieldPermission';
 export type { FilestackImageMetaResponseModel } from './models/FilestackImageMetaResponseModel';
 export { Gender } from './models/Gender';
@@ -161,6 +171,11 @@ export type { ImageUploadHistory } from './models/ImageUploadHistory';
 export type { ImageUploadHistoryPage } from './models/ImageUploadHistoryPage';
 export type { ImageUploadHistoryPatch } from './models/ImageUploadHistoryPatch';
 export type { ImageUploadHistoryPost } from './models/ImageUploadHistoryPost';
+export type { IntegrationCodelocksSettings } from './models/IntegrationCodelocksSettings';
+export type { IntegrationCodelocksSettingsCreate } from './models/IntegrationCodelocksSettingsCreate';
+export type { IntegrationCodelocksSettingsPage } from './models/IntegrationCodelocksSettingsPage';
+export type { IntegrationCodelocksSettingsPatch } from './models/IntegrationCodelocksSettingsPatch';
+export type { IntegrationCodelocksSettingsPost } from './models/IntegrationCodelocksSettingsPost';
 export type { IntegrationDotdigitalFieldMap } from './models/IntegrationDotdigitalFieldMap';
 export type { IntegrationDotdigitalFieldMapPage } from './models/IntegrationDotdigitalFieldMapPage';
 export type { IntegrationDotdigitalFieldMapPatch } from './models/IntegrationDotdigitalFieldMapPatch';
@@ -223,6 +238,7 @@ export type { OrderApplyDiscountCode } from './models/OrderApplyDiscountCode';
 export type { OrderDeal } from './models/OrderDeal';
 export type { OrderEmailCustomerPatch } from './models/OrderEmailCustomerPatch';
 export type { OrderItem } from './models/OrderItem';
+export type { OrderItemCodelocksAccess } from './models/OrderItemCodelocksAccess';
 export type { OrderItemDeal } from './models/OrderItemDeal';
 export type { OrderItemPage } from './models/OrderItemPage';
 export type { OrderItemPatch } from './models/OrderItemPatch';
@@ -327,6 +343,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';
@@ -520,6 +540,7 @@ export type { WalletTransactionPost } from './models/WalletTransactionPost';
 export { WalletTransactionType } from './models/WalletTransactionType';
 export { WebsiteHomepage } from './models/WebsiteHomepage';
 
+export { AccessCredentialsService } from './services/AccessCredentialsService';
 export { ActivityService } from './services/ActivityService';
 export { ActivityPerformanceService } from './services/ActivityPerformanceService';
 export { ActivityTypeCategoryService } from './services/ActivityTypeCategoryService';
@@ -529,6 +550,7 @@ export { BadEnglandReportService } from './services/BadEnglandReportService';
 export { BookingService } from './services/BookingService';
 export { CancellationPoliciesService } from './services/CancellationPoliciesService';
 export { ChatService } from './services/ChatService';
+export { CodelocksLocksService } from './services/CodelocksLocksService';
 export { CountryService } from './services/CountryService';
 export { CoursesService } from './services/CoursesService';
 export { CourseSessionsService } from './services/CourseSessionsService';
@@ -547,6 +569,7 @@ export { EndUserIdentitySecureTokenService } from './services/EndUserIdentitySec
 export { EnglandGolfReportService } from './services/EnglandGolfReportService';
 export { FacilitiesService } from './services/FacilitiesService';
 export { FacilityIndividualsService } from './services/FacilityIndividualsService';
+export { FeatureAnnouncementsService } from './services/FeatureAnnouncementsService';
 export { FilestackService } from './services/FilestackService';
 export { GenericActivityService } from './services/GenericActivityService';
 export { GeocodeService } from './services/GeocodeService';
@@ -556,6 +579,7 @@ export { ImageLibraryCategoryService } from './services/ImageLibraryCategoryServ
 export { ImageLibraryImageService } from './services/ImageLibraryImageService';
 export { ImagesService } from './services/ImagesService';
 export { ImageUploadHistoryService } from './services/ImageUploadHistoryService';
+export { IntegrationCodelocksSettingsService } from './services/IntegrationCodelocksSettingsService';
 export { IntegrationDotdigitalFieldMapService } from './services/IntegrationDotdigitalFieldMapService';
 export { IntegrationDotdigitalLogService } from './services/IntegrationDotdigitalLogService';
 export { IntegrationDotDigitalSettingsService } from './services/IntegrationDotDigitalSettingsService';
@@ -598,6 +622,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 +640,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/AccessCredential.ts

@@ -0,0 +1,74 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Lifecycle record for a generated or pending access code (e.g. Codelocks NetCode) tied to an order.
+ */
+export type AccessCredential = {
+  /**
+   * 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 registered lock used when generating the code.
+   */
+  codelocksLockId?: string;
+  /**
+   * Gets or sets the parent order id.
+   */
+  orderId?: string;
+  /**
+   * Gets or sets the order line id when the grant applies to a single line.
+   */
+  orderItemId?: string | null;
+  /**
+   * Gets or sets the credential lifecycle status (see Reach.Models.AccessCredentialStatus).
+   */
+  status?: string | null;
+  /**
+   * Gets or sets the idempotency key for generation and queue processing.
+   */
+  idempotencyKey?: string | null;
+  /**
+   * Gets or sets the generated access code when available.
+   */
+  accessCode?: string | null;
+  /**
+   * Gets or sets the validity start (UTC).
+   */
+  validFromUtc?: string | null;
+  /**
+   * Gets or sets the validity end (UTC).
+   */
+  validToUtc?: string | null;
+  /**
+   * Gets or sets when the code was successfully retrieved from the supplier.
+   */
+  generatedUtc?: string | null;
+  /**
+   * Gets or sets when the customer was notified or saw the code in a channel.
+   */
+  deliveredToCustomerUtc?: string | null;
+};

package/src/models/AccessCredentialPage.ts

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

package/src/models/AccessCredentialPatch.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for access credential updates.
+ */
+export type AccessCredentialPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+};

package/src/models/AccessCredentialPost.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for access credential inserts (system use).
+ */
+export type AccessCredentialPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+};

package/src/models/ActivityType.ts

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

package/src/models/CodelocksLock.ts

@@ -0,0 +1,62 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Tenant-scoped registry entry for a physical Codelocks device used when generating NetCodes.
+ */
+export type CodelocksLock = {
+  /**
+   * 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 display name for the lock.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets an optional location description (e.g. door, building).
+   */
+  location?: string | null;
+  /**
+   * Gets or sets the IANA timezone for lock-side scheduling context.
+   */
+  timezone?: string | null;
+  /**
+   * Gets or sets the supplier lock model (e.g. KL1060, C3SMART).
+   */
+  lockModel?: string | null;
+  /**
+   * Gets or sets the path segment for `GET .../netcode/{id}` (C3SMART LockID or timecode for other models).
+   */
+  netcodePathId?: string | null;
+  /**
+   * Gets or sets the lock identifier sent as the `identifer` query parameter to Codelocks Connect.
+   */
+  identifier?: string | null;
+  /**
+   * Gets or sets a value indicating whether this lock can be selected for new bookings.
+   */
+  isActive?: boolean;
+};

package/src/models/CodelocksLockPage.ts

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

package/src/models/CodelocksLockPatch.ts

@@ -0,0 +1,46 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for Codelocks lock updates.
+ */
+export type CodelocksLockPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  /**
+   * Gets or sets the display name for the lock.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets an optional location description.
+   */
+  location?: string | null;
+  /**
+   * Gets or sets the IANA timezone.
+   */
+  timezone?: string | null;
+  /**
+   * Gets or sets the supplier lock model.
+   */
+  lockModel?: string | null;
+  /**
+   * Gets or sets the NetCode path id.
+   */
+  netcodePathId?: string | null;
+  /**
+   * Gets or sets the lock identifier for the Codelocks API.
+   */
+  identifier?: string | null;
+  /**
+   * Gets or sets a value indicating whether this lock is active.
+   */
+  isActive?: boolean | null;
+};

package/src/models/CodelocksLockPost.ts

@@ -0,0 +1,42 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for Codelocks lock inserts.
+ */
+export type CodelocksLockPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the display name for the lock.
+   */
+  name?: string | null;
+  /**
+   * Gets or sets an optional location description.
+   */
+  location?: string | null;
+  /**
+   * Gets or sets the IANA timezone.
+   */
+  timezone?: string | null;
+  /**
+   * Gets or sets the supplier lock model.
+   */
+  lockModel?: string | null;
+  /**
+   * Gets or sets the NetCode path id.
+   */
+  netcodePathId?: string | null;
+  /**
+   * Gets or sets the lock identifier for the Codelocks API.
+   */
+  identifier?: string | null;
+  /**
+   * Gets or sets a value indicating whether this lock is active.
+   */
+  isActive?: boolean | null;
+};

package/src/models/Course.ts

@@ -63,6 +63,10 @@ export type Course = {
    * Gets or sets the activity venue id.
    */
   venueId?: string | null;
+  /**
+   * Gets or sets the optional registered Codelocks lock for NetCode access (course or session template).
+   */
+  codelocksLockId?: string | null;
   /**
    * Gets or sets the session activity id.
    */

package/src/models/CourseCreate.ts

@@ -150,4 +150,8 @@ export type CourseCreate = {
    * Gets or sets the session deals.
    */
   deals?: Array<CreateDeal> | null;
+  /**
+   * Gets or sets the optional registered Codelocks lock for NetCode access.
+   */
+  codelocksLockId?: string | null;
 };

package/src/models/CoursePatch.ts

@@ -169,6 +169,10 @@ export type CoursePatch = {
    * Gets or sets optional storefront message for pre-registration.
    */
   preRegistrationMessage?: string | null;
+  /**
+   * Gets or sets the optional registered Codelocks lock for NetCode access.
+   */
+  codelocksLockId?: string | null;
   emailSettings?: UpdateEmailSettings;
   /**
    * Gets or sets the course offers.

package/src/models/CourseSession.ts

@@ -50,7 +50,7 @@ export type CourseSession = {
   /**
    * Gets or sets the session id.
    */
-  courseId?: string | null;
+  courseId: string;
   status?: SlotStatus;
   /**
    * Gets or sets the scheduled session creation lease expiry. Preventing other scheduled sessions from overwriting until the lease expires.

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

@@ -46,11 +46,11 @@ export type Facility = {
   /**
    * Gets or sets the facility venue id.
    */
-  venueId?: string | null;
+  venueId: string;
   /**
    * Gets or sets the facility activity id.
    */
-  activityId?: number | null;
+  activityId: number;
   /**
    * Gets or sets the facility survey id.
    */
@@ -62,11 +62,11 @@ export type Facility = {
   /**
    * Gets or sets the facility name.
    */
-  name?: string | null;
+  name: string;
   /**
    * Gets or sets the facility description.
    */
-  description?: string | null;
+  description: string;
   /**
    * Gets or sets the facility image url.
    * @deprecated
@@ -97,6 +97,10 @@ export type Facility = {
    * Gets or sets a value indicating whether the facility is deleted and should be ignored under normal operation.
    */
   deleted?: boolean | null;
+  /**
+   * Gets or sets the optional registered Codelocks lock used for NetCode access at this facility.
+   */
+  codelocksLockId?: string | null;
   nextAvailableOpportunity?: Slot;
   venue?: Venue;
   activity?: Activity;

package/src/models/FacilityPatch.ts

@@ -18,4 +18,8 @@ export type FacilityPatch = {
    */
   id: string;
   emailSettings?: UpdateEmailSettings;
+  /**
+   * Gets or sets the optional registered Codelocks lock for NetCode access.
+   */
+  codelocksLockId?: string | null;
 };

package/src/models/FacilityPost.ts

@@ -14,4 +14,8 @@ export type FacilityPost = {
    */
   tenantId: string;
   emailSettings?: UpdateEmailSettings;
+  /**
+   * Gets or sets the optional registered Codelocks lock for NetCode access.
+   */
+  codelocksLockId?: string | null;
 };

package/src/models/FeatureAnnouncementDismissPost.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Request body to dismiss a feature announcement for the current user.
+ */
+export type FeatureAnnouncementDismissPost = {
+  /**
+   * Gets or sets the announcement identifier to dismiss.
+   */
+  featureAnnouncementId?: string;
+};

package/src/models/FeatureAnnouncementForUserDto.ts

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Feature announcement payload returned to the partner app for the current user.
+ */
+export type FeatureAnnouncementForUserDto = {
+  /**
+   * Gets or sets the identifier.
+   */
+  id?: string;
+  /**
+   * Gets or sets the slug.
+   */
+  slug?: string | null;
+  /**
+   * Gets or sets the version.
+   */
+  version?: number;
+  /**
+   * Gets or sets the widget title.
+   */
+  title?: string | null;
+  /**
+   * Gets or sets the short summary.
+   */
+  summary?: string | null;
+  /**
+   * Gets or sets the modal body.
+   */
+  detailBody?: string | null;
+  /**
+   * Gets or sets an optional URL.
+   */
+  url?: string | null;
+};

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

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Per-tenant Codelocks integration settings. The shared Codelocks API key is not stored here — it lives in Reach API configuration.
+ */
+export type IntegrationCodelocksSettings = {
+  /**
+   * 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 a value indicating whether NetCode generation is enabled for this tenant.
+   */
+  enabled?: boolean | null;
+};