reach-api-sdk 1.0.228 → 1.0.230

package/src/index.ts

@@ -83,6 +83,10 @@ export { CustomDateRange } from './models/CustomDateRange';
 export type { CustomDateRangeOption } from './models/CustomDateRangeOption';
 export type { Customer } from './models/Customer';
 export type { CustomerAccountInvitePatch } from './models/CustomerAccountInvitePatch';
+export type { CustomerAccountInviteSchedule } from './models/CustomerAccountInviteSchedule';
+export type { CustomerAccountInviteSchedulePage } from './models/CustomerAccountInviteSchedulePage';
+export type { CustomerAccountInviteSchedulePatch } from './models/CustomerAccountInviteSchedulePatch';
+export type { CustomerAccountInviteSchedulePost } from './models/CustomerAccountInviteSchedulePost';
 export { CustomerCancellationOption } from './models/CustomerCancellationOption';
 export type { CustomerEmailPatch } from './models/CustomerEmailPatch';
 export type { CustomerPage } from './models/CustomerPage';
@@ -562,6 +566,7 @@ export { CountryService } from './services/CountryService';
 export { CoursesService } from './services/CoursesService';
 export { CourseSessionsService } from './services/CourseSessionsService';
 export { CourseSessionSchedulesService } from './services/CourseSessionSchedulesService';
+export { CustomerAccountInviteSchedulesService } from './services/CustomerAccountInviteSchedulesService';
 export { CustomerAuthService } from './services/CustomerAuthService';
 export { CustomerPortalService } from './services/CustomerPortalService';
 export { CustomersService } from './services/CustomersService';

package/src/models/Attendee.ts

@@ -50,6 +50,10 @@ export type Attendee = {
    * Gets or sets the last name.
    */
   lastName: string;
+  /**
+   * Gets or sets the tenant-scoped external reference for integration with external systems.
+   */
+  externalReference?: string | null;
   /**
    * Gets the attendees abbreviated name.
    */

package/src/models/AttendeePatch.ts

@@ -29,4 +29,9 @@ export type AttendeePatch = {
    * patch fields are applied to that record as well as to the attendee row where applicable.
    */
   dateOfBirth?: string | null;
+  /**
+   * Gets or sets the tenant-scoped external reference for integration with external systems.
+   * Only applicable when enable_attendee_external_reference is enabled for the tenant.
+   */
+  externalReference?: string | null;
 };

package/src/models/AttendeePost.ts

@@ -53,4 +53,9 @@ export type AttendeePost = {
    * This is used to resolve or create the linked end_user_identity record for person-level identity tracking.
    */
   dateOfBirth?: string | null;
+  /**
+   * Gets or sets the tenant-scoped external reference for integration with external systems.
+   * Only applicable when enable_attendee_external_reference is enabled for the tenant.
+   */
+  externalReference?: string | null;
 };

package/src/models/CustomerAccountInviteSchedule.ts

@@ -0,0 +1,54 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents a scheduled customer account invite email tied to a wallet credit period.
+ */
+export type CustomerAccountInviteSchedule = {
+  /**
+   * 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 customer id.
+   */
+  customerId?: string;
+  /**
+   * Gets or sets the wallet credit period id that triggered this invite schedule.
+   */
+  walletCreditPeriodId?: string;
+  /**
+   * Gets or sets the date the invite is scheduled to send.
+   */
+  dateScheduled?: string;
+  /**
+   * Gets or sets a value indicating whether the invite has been sent.
+   */
+  sent?: boolean;
+  /**
+   * Gets or sets a value indicating whether sending the invite errored.
+   */
+  errored?: boolean;
+};

package/src/models/CustomerAccountInviteSchedulePage.ts

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

package/src/models/CustomerAccountInviteSchedulePatch.ts

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

package/src/models/CustomerAccountInviteSchedulePost.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for customer account invite schedule inserts.
+ */
+export type CustomerAccountInviteSchedulePost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+};

package/src/models/TenantSetting.ts

@@ -68,6 +68,12 @@ export type TenantSetting = {
    * When enabled, attendee wallets require an active credit period for bookings and allocation management.
    */
   enableWalletCreditPeriods?: boolean;
+  /**
+   * Gets or sets how many days before a credit period start date to send the customer account invite.
+   * Allowed values: 0 (on period start), 7 (one week before), 14 (two weeks before).
+   * Only applies when Reach.Models.TenantSetting.EnableWalletCreditPeriods is true.
+   */
+  walletCreditPeriodAccountInviteDaysBefore?: number | null;
   /**
    * Gets or sets a value indicating whether customer portal WorkOS login is restricted to pre-provisioned customers only.
    * When true, the authenticated email must match a live customer row (email or display_email) for this tenant.
@@ -83,6 +89,18 @@ export type TenantSetting = {
    * When false (default), storefronts should hide WorkOS sign-in; use for phased rollout per tenant.
    */
   customerPortalWorkOsLoginEnabled?: boolean;
+  /**
+   * Gets or sets a value indicating whether attendee external references are enabled for the tenant.
+   */
+  enableAttendeeExternalReference?: boolean;
+  /**
+   * Gets or sets a value indicating whether external_reference is required when creating attendees.
+   */
+  requireAttendeeExternalReference?: boolean;
+  /**
+   * Gets or sets the label shown for the attendee external reference field in partner UI.
+   */
+  attendeeExternalReferenceLabel?: string | null;
   /**
    * Gets the next order number in the sequence.
    */

package/src/models/TenantStorefrontSettingsPatch.ts

@@ -17,4 +17,10 @@ export type TenantStorefrontSettingsPatch = {
    * When null, PATCH leaves the existing database value unchanged.
    */
   customerPortalWorkOsLoginEnabled?: boolean | null;
+  /**
+   * Gets or sets how many days before a credit period start date to automatically send customer account invites.
+   * Allowed values: 0 (on period start), 7 (one week before), 14 (two weeks before).
+   * When null, PATCH leaves the existing database value unchanged.
+   */
+  walletCreditPeriodAccountInviteDaysBefore?: number | null;
 };

package/src/services/AttendeesService.ts

@@ -153,6 +153,7 @@ export class AttendeesService {
     customerId,
     firstName,
     lastName,
+    externalReference,
     pageNumber,
     take,
     skip,
@@ -177,6 +178,10 @@ export class AttendeesService {
      * Gets or sets the queryable attendee last name.
      */
     lastName?: string;
+    /**
+     * Gets or sets the queryable attendee external reference.
+     */
+    externalReference?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -229,6 +234,7 @@ export class AttendeesService {
         CustomerId: customerId,
         FirstName: firstName,
         LastName: lastName,
+        ExternalReference: externalReference,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -339,6 +345,7 @@ export class AttendeesService {
     customerId,
     firstName,
     lastName,
+    externalReference,
     pageNumber,
     take,
     skip,
@@ -363,6 +370,10 @@ export class AttendeesService {
      * Gets or sets the queryable attendee last name.
      */
     lastName?: string;
+    /**
+     * Gets or sets the queryable attendee external reference.
+     */
+    externalReference?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -415,6 +426,7 @@ export class AttendeesService {
         CustomerId: customerId,
         FirstName: firstName,
         LastName: lastName,
+        ExternalReference: externalReference,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -444,6 +456,7 @@ export class AttendeesService {
     customerId,
     firstName,
     lastName,
+    externalReference,
     pageNumber,
     take,
     skip,
@@ -468,6 +481,10 @@ export class AttendeesService {
      * Gets or sets the queryable attendee last name.
      */
     lastName?: string;
+    /**
+     * Gets or sets the queryable attendee external reference.
+     */
+    externalReference?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -520,6 +537,7 @@ export class AttendeesService {
         CustomerId: customerId,
         FirstName: firstName,
         LastName: lastName,
+        ExternalReference: externalReference,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -549,6 +567,7 @@ export class AttendeesService {
     customerId,
     firstName,
     lastName,
+    externalReference,
     pageNumber,
     take,
     skip,
@@ -573,6 +592,10 @@ export class AttendeesService {
      * Gets or sets the queryable attendee last name.
      */
     lastName?: string;
+    /**
+     * Gets or sets the queryable attendee external reference.
+     */
+    externalReference?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -625,6 +648,7 @@ export class AttendeesService {
         CustomerId: customerId,
         FirstName: firstName,
         LastName: lastName,
+        ExternalReference: externalReference,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -654,6 +678,7 @@ export class AttendeesService {
     customerId,
     firstName,
     lastName,
+    externalReference,
     pageNumber,
     take,
     skip,
@@ -678,6 +703,10 @@ export class AttendeesService {
      * Gets or sets the queryable attendee last name.
      */
     lastName?: string;
+    /**
+     * Gets or sets the queryable attendee external reference.
+     */
+    externalReference?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -730,6 +759,7 @@ export class AttendeesService {
         CustomerId: customerId,
         FirstName: firstName,
         LastName: lastName,
+        ExternalReference: externalReference,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,